Tokens are authentication keys and are always associated with an app. They are used to identify the caller and restrict the data available via API.
Tokens are made available in the following ways:
Each kind of token provides a different schema:
We support the Bearer authentication scheme, so you can do one of the following:
Authorization: Bearer TOKEN.
access_token. This only works for POST requests with either
Note: Make sure to access the Optix GraphQL API using a valid access token, otherwise you will not see the full schema.
This tool provides a map of all objects available to you. You can navigate and read the documentation for each field, and also visualize the connections between objects.
You can also access the Voyager through the link provided in the ‘Develop’ page of the Optix admin dashboard, using the organization or personal token menu item:
The menus in the admin dashboard in ‘Apps –> Develop –> your app’ where you’ll find links to launch the Voyager tool with your tokens pre-filled.
This provides a debug tool and documentation during the creation of a GraphQL query. Feel free to explore all the objects and test out all the parameters available. Click ‘Docs’ on the right to pull out a section where you can find information to help understand each object. This demo allows you to read (‘Query’) data, but writing (via ‘Mutations’) is blocked.
This example is a query that fetches the name and email of the currently logged in user. Click the play button to run it. You could try adding a new line after
user_id to get a feel for how it works. You can also open this example in another tab if you like.
In the above example playground, mutations (writing to the API) are disabled.
You can also access the playground through the link provided in the ‘Develop’ page of the Optix admin dashboard, using the organization or personal token menu item:
The menus in the admin dashboard in ‘Apps –> Develop –> your app’ where you’ll find links to launch the Playground tool with your tokens pre-filled.