Este artigo explica como usar o GraphQL Playground para executar algumas consultas de exemplo e testar a conectividade com o Endpoint da API do Cato Networks.
O GraphQL Playground permite que você execute consultas de API que são enviadas diretamente para o Servidor de API Cato. Software de consulta de API de terceiros, como Altair ou Postman, oferece funcionalidades poderosas para execução de chamadas de 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 em Cato API a partir do GraphQL Playground, você deve ter a Chave API para sua conta (Recursos > Chaves de API). Para mais informações sobre as Chaves API, consulte Gerando Chaves API para a API Cato.
Você precisa inserir o ID do Aplicativo de Gerenciamento Cato (CMA) para sua conta nas consultas de exemplo. Você pode encontrar o CMA ID na página Informações da Conta.
A URL para o endpoint da API é específica para o local onde a instância do Aplicativo de Gerenciamento Cato (CMA) está hospedada. Pode haver um valor <prefix> que é adicionado à URL da sua conta CMA e ao endpoint da API.
-
Se não houver prefixo (
cc.catonetworks.com), use o seguinte URL:https://api.catonetworks.com/api/v1/graphql2 -
Se houver um prefixo (como
cc.us1.catonetworks.com), então você deve usar o seguinte URL:https://api.us1.catonetworks.com/api/v1/graphql2
Você pode executar uma consulta de exemplo de API para testar a conectividade com o Servidor de API Cato. Quando o argumento accountID e a Chave API estão configurados corretamente, a consulta de exemplo de API retorna os Dados da Conta e mostra os Resultados no GraphQL Playground. Se a consulta não retornar Resultados para sua conta, pode haver um problema de conectividade com o Servidor de API ou o Servidor pode estar fora de operação. As seguintes consultas de exemplo de API podem ajudá-lo a testar a conectividade com o Servidor de API Cato:
Use um navegador de Internet para abrir o GraphQL Playground para a API do Cato. Configure o cabeçalho HTTP para o Playground com sua Chave API. Cole a consulta de exemplo no painel da esquerda e insira seu ID da Conta. Então você pode executar a consulta e ver os resultados no Playground.
-
Baixe uma das consultas de exemplo de API deste artigo e abra o Arquivo em um Editor de texto, como o Bloco de Notas.
-
De um navegador de Internet, vá até o GraphQL Playground para a API do Cato.
-
Na parte inferior do painel esquerdo, clique em HTTP HEADERS.
-
Digite 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 exemplo no painel esquerdo do Playground.
-
No topo da consulta, no argumento
accountID, digite seu ID da Conta.A captura de tela a seguir mostra o argumento
accountIDconfigurado com o valor 2626: -
Clique no botão de reprodução.
-
O painel direito mostra os resultados da consulta API. A captura de tela a seguir mostra os resultados da consulta de exemplo accountMetrics para o ID da Conta 2626:
0 comentário
Por favor, entre para comentar.