Page Comparison

You can run queries on real Scope data using any HTTP compliant client (HTTP Client) or GraphQL integrated development environment (GraphQL IDE). GraphQL IDEs are typically easier to work with because they include docs, syntax highlighting, and validation errors.

...

Scope GraphQL Explorer is an instance of GraphiQL (a GraphQL IDE) that is available in-browser at https://cms.scopear.com/api/v3/graphql/explorer.

Using GraphiQL

To use the GraphiQL app, download and install it from https://www.electronjs.org/apps/graphiql.

...

You must obtain a valid OAuth token before attempting to execute queries against, or explore the schema of, the Scope API.

There are two kinds of OAuth tokens:

1. “Permanent” API tokens that never expire.

2. “Temporary” Session based tokens that expire after 30 days (or “sign-out”, whichever is earlier).

To obtain a permanent API token:

Contact support and request that a Scope Admin create and enable an API token for your organization.

To obtain a temporary session token:

Obtaining an OAuth token

1. Use your favorite HTTP client to sign in:

   Code Block
   curl --request POST \ --url https://cms.scopear.com/api/v2/users/sign_in.json \ --header 'Content-Type: application/x-www-form-urlencoded' \ --data 'user[username]=YOUR_EMAIL' \ --data 'user[password]=YOUR_PASSWORD'

2. Parse the response as JSON and extract the value for the auth_token key (e.g. the following response should yield the following token):

   Code Block

   { "id": 1, "email": "support@scopear.com", "name": "Support Account", "permalink": "supportscopearcom", "username": "support@scopear.com", "guest": false, "auth_token": "eyJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJfaWQiOjEsImRldmljZV9pZCI6MX0sImV4cCI6MTYwODI0NDA3MSwianRpIjoiOGY3ODg1NTg2Y2Y4YTdiNjQ1MWIwZTcxMzFhODY1MDE2MmQwZWZhZjc3MTgwYTNhZmU5OTk2N2Y4OTZhNzlhOCIsImlhdCI6MTYwNTY1MjA3MX0.Z4hFOmLlUPolvW3u-2Ssn7LWX_c2y95a1fhID3QJuCg", ...

   => eyJhbGciOiJIUzI1NiJ9.eyJkYXRhIjp7InVzZXJfaWQiOjEsImRldmljZV9pZCI6MX0sImV4cCI6MTYwODI0NDA3MSwianRpIjoiOGY3ODg1NTg2Y2Y4YTdiNjQ1MWIwZTcxMzFhODY1MDE2MmQwZWZhZjc3MTgwYTNhZmU5OTk2N2Y4OTZhNzlhOCIsImlhdCI6MTYwNTY1MjA3MX0.Z4hFOmLlUPolvW3u-2Ssn7LWX_c2y95a1fhID3QJuCg

You may now use this token wherever an OAuth token is required (until it expires).

Refreshing an OAuth token

Scope OAuth tokens currently expire after 30 days (or “sign-out”, whichever is earlier).