First Steps GraphQL API

Learn how to access Azion GraphQL API and the GraphQL playground.

Accessing GraphQL API

To use GraphQL API with API platforms such as Postman and Insomnia, you first need authentication to ensure requests access data securely. This authentication occurs through Tokens.

To create a Token, you can follow two different paths:

  • Use Azion API platform.
  • Use Azion Console.

The first option is to create a Token through the Azion API platform. You can go to Token and run your request.

The second option is to create a Personal Token through the Azion configuration interface, Azion Console. This option is more suitable for use with APIs due to the possibility of creating a long-lived token. See the Personal Tokens documentation page to create one.

After creating your personal token, head to the API platform you’ll be using and include the Azion GraphQL API endpoint in your request:

  • To use the Real-Time Metrics API for aggregated data, include: https://api.azionapi.net/metrics/graphql
  • To use the Real-Time Events API for raw data, include: https://api.azionapi.net/events/graphql
  • To use the Billing API for financial data, include: https://api.azionapi.net/billing/graphql
  • To use the Accounting API for financial data, include: https://api.azionapi.net/accounting/graphql

Accessing GraphQL playground

You can use Azion GraphQL built-in playground to write, validate, and test GraphQL queries. Using the playground can help you become more familiar with the API and the use of queries in a visual and quick manner.

To interact with the GraphQL playground, you first need to log in to Azion Console. If you haven’t created an account, see the Creating an account on Azion documentation page.

After successfully logging in to Azion Console, go to one of the links:

  • https://manager.azion.com/metrics/graphql
  • https://manager.azion.com/events/graphql
  • https://manager.azion.com/billing/graphql
  • https://manager.azion.com/accounting/graphql

Feel free to interact with the GraphQL API playground.

Watch a video tutorial on GraphQL’s first steps on Azion’s YouTube channel:

Contributors