Este artigo explica como usar o GraphQL Playground para executar algumas consultas de amostra e testar a conectividade com o endpoint da API Cato Networks.
O GraphQL Playground permite executar consultas de API que são enviadas diretamente para o servidor API Cato. Softwares de consulta de API de terceiros, como Altair ou Postman, oferecem funcionalidades poderosas para executar chamadas API. No entanto, se houver um problema de conectividade com consultas de API, você pode usar o Playground para ajudar a identificar a causa do problema.
Para executar uma consulta de API Cato a partir do GraphQL Playground, você deve ter a chave da API para sua conta (Recursos > Chaves API). Para mais informações sobre as chaves API, consulte Gerando Chaves API para a API Cato.
Você precisa inserir o ID da Aplicação de Gerenciamento Cato (CMA) para sua conta nas consultas de amostra. Você pode encontrar o ID da CMA na página de Informações da Conta.
A URL para o endpoint da API é específica para o local onde a instância da Aplicação de Gerenciamento Cato (CMA) está hospedada. Pode haver um valor de
-
Se não houver prefixo (
cc.catonetworks.com), então use a seguinte URL:https://api.catonetworks.com/api/v1/graphql2 -
Se houver um prefixo (como
cc.us1.catonetworks.com), então você usaria a seguinte URL:https://api.us1.catonetworks.com/api/v1/graphql2
Você pode executar uma consulta de API de amostra para testar a conectividade com o servidor da API Cato. Quando o argumento accountID e a chave API são configurados corretamente, a consulta de API de amostra retorna os dados da conta e mostra os resultados no GraphQL Playground. Se a consulta não retornar resultados para sua conta, então pode haver um problema de conectividade com o servidor API ou o servidor pode estar fora do ar. As seguintes consultas de API de amostra podem ajudá-lo a testar a conectividade com o servidor da API Cato:
Use um navegador da Internet para abrir o GraphQL Playground para a API Cato. Configure o cabeçalho HTTP para o Playground com sua chave API. Cole a consulta de amostra no painel à esquerda e insira o ID da sua conta. Então você pode executar a consulta e ver os resultados no Playground.
-
Baixe uma das consultas de API de amostra deste artigo e abra o arquivo em um editor de texto, como o Notepad.
-
A partir de um navegador da Internet, vá para o GraphQL Playground para a API Cato.
-
Na parte inferior do painel à esquerda, clique em HTTP HEADERS.
-
Insira sua chave API neste formato:
{ "x-api-key" :"<api key>" }.A captura de tela a seguir mostra o cabeçalho HTTP configurado com a chave APIAaBbCcDdEeFf0123456789ABCDEF1234:
-
Copie e cole uma das consultas de amostra no painel à esquerda do Playground.
-
No topo da consulta, no argumento
accountID, insira o ID da sua conta.A captura de tela a seguir mostra o argumento
accountIDconfigurado com o valor 2626: -
Clique no botão de execução.
-
O painel à direita mostra os resultados da consulta de API. A captura de tela a seguir mostra os resultados para a consulta accountMetrics de amostra para o ID da conta 2626:
0 comentário
Por favor, entre para comentar.