Usando o Altair

O Altair é uma aplicação para executar queries/mutations em GraphQL. Nele você poderá construir e conferir o resultado das requisições na web, antes de colocar em seu código.

O passo mais importante para usar o Altair é acessar esse link: https://altair.autentique.com.br (Nós fizemos algumas pequenas mudanças no client padrão do Altair pra facilitar a sua vida, como collections personalizadas com as principais ações do Autentique)

Headers das requisições

Ao abrir o link, a primeira tela que você verá será a de Headers.

Como você já deve ter imaginado, são esses os headers que você precisa passar ao fazer uma requisição para a API, e que aquele SUA_CHAVE_DE_API deve ser substituído pela sua chave de API (sim, já aconteceu). O Altair inicia no ambiente de Sandbox/Testes então você pode iniciar substituindo pela chave de sandbox gerada no painel do Autentique.

Não remova o trecho "Bearer" na frente da chave de API, substitua apenas o que vem depois dele

Caso você queira alterar sua chave, você poderá acessar essa tela novamente em Set Headers:

Ambientes de desenvolvimento

Os ambientes de desenvolvimento contém variáveis que possuem valores distintos, dependendo do ambiente ativo:

Há duas coisas interessantes nessa imagem. A primeira é o {{endpointURL}} que é a variável definida na segunda coisa interessante, que é o ambiente de desenvolvimento Sandbox, ali no canto superior direito. Você pode alterar entre o ambiente de sandbox e production, assim a variável será automaticamente atualizada para a respectiva URL automaticamente.

No mesmo menu há a opção "Environments..." que possui a definição dessas variáveis:

Coleções

Nós criamos algumas collections com as principais ações/queries utilizadas no Autentique. Você pode conferir/testar/utilizar elas em seu projeto ou como referência para criar as suas próprias queries.

As collections são só exemplos, portanto não são uma representação de tudo o quê você pode fazer com a API. E tem algumas que você precisa completar alguns parâmetros para funcionar, como IDs do documento, pastas etc.

As collections podem não estar funcionando no Firefox com o modo privado ativo.

Documentação

Além das collections, há uma documentação nativa muito mais completa que contém tudo que você pode fazer com a API.

Ao clicar em Docs, no topo da tela, será exibida uma barra lateral contendo a documentação. Caso esteja vazio para você, clique em Reload Docs para recarregar a documentação ou, se mesmo assim não estiver aparecendo nada, confira nos Headers se você colocou a chave de API correspondente ao ambiente de desenvolvimento Sandbox ou Production e tente novamente.

Os primeiros itens são Query (funções para apenas buscar informações) e Mutation (funções que executam algum tipo de ação ou mudança). Ao clicar em alguma delas será exibido o que você pode fazer com a API no momento, contendo todas as funções que podem ser enviadas e informações consultáveis.

Nos próximos passos, vamos mostrar algumas dessas queries/mutations e como executá-las no Altair.

Se você quer sair integrando e o Altair não está ajudando (você pode copiar a requisição como cURL no Altair), confira algumas SDKs/bibliotecas que podem ajudar: https://github.com/chentsulin/awesome-graphql

Sim, o nome Altair é uma referência a Assassin's Creed e isso talvez tenha sido considerado quando escolhemos ele