Primeiros Passos API GraphQL

Descubra como acessar e autenticar na API GraphQL da Azion, criar tokens seguros e usar o playground para testar e otimizar queries.

Ver como Markdown

Veja como acessar a API GraphQL da Azion e o playground da GraphQL.

Acessar a API GraphQL

Para utilizar a API GraphQL com plataformas de API, como Postman e Insomnia, você precisa autenticar seu acesso para garantir que as requisições sejam realizadas de forma segura. A autenticação ocorre através do uso de Tokens.

Para criar um Token, você tem duas opções:

  • Utilizar a plataforma de API da Azion.
  • Usar o Azion Console.

A primeira opção é criar um Token através da plataforma de API da Azion. Vá até Token e execute a sua requisição.

A segunda opção é criar um Personal Token através da interface de configuração da Azion, Azion Console. Essa opção pode ser mais adequada para uso com APIs, pois proporciona a criação de um token de longa duração. Veja a página de documentação de Personal Tokens para mais informações.

Ao criar um personal token, você deve informar uma data de expiração. Para uso com APIs, é recomendado usar uma data de expiração mais longa, como 90 dias ou 1 ano. Nesse caso, tome as medidas necessárias para garantir a segurança do seu projeto.

Após criar o seu personal token, vá para a plataforma de API de sua escolha e inclua o endpoint da API GraphQL da Azion em sua requisição:

  • Para usar a API Real-Time Metrics com dados agregados, inclua: https://api.azion.com/v4/metrics/graphql
  • Para usar a API Real-Time Events com dados brutos, inclua: https://api.azion.com/v4/events/graphql
  • Para usar a API Billing com dados financeiros, inclua: https://api.azion.com/v4/billing/graphql
  • Para usar a API Accounting com dados financeiros, inclua: https://api.azion.com/v4/accounting/graphql
  • Para usar a API Consumption com dados de uso dos produtos, inclua: https://api.azion.com/v4/consumption/graphql

Acessar o GraphiQL Playground

Você pode usar o playground da GraphQL da Azion para escrever, validar e testar queries da GraphQL. Usar o playground também ajuda a conhecer melhor a API e o uso de queries de forma visual e rápida.

Para interagir com o playground da GraphQL, você deve estar logado no Azion Console. Se você ainda não criou uma conta, veja a página de documentação Criar uma conta na Azion.

Após fazer login no Console, acesse um dos links:

  • https://api.azion.com/v4/metrics/graphql
  • https://api.azion.com/v4/events/graphql
  • https://api.azion.com/v4/billing/graphql
  • https://api.azion.com/v4/accounting/graphql
  • https://api.azion.com/v4/consumption/graphql

Interaja com o playground da GraphQL API livremente.

Após executar uma query, o caminho da URL é atualizado com um parâmetro codificado da query específica que você está utilizando. Você pode copiar e compartilhar a URL com outros usuários para que usem a mesma query que você.