Este artigo explica como usar o Playground GraphQL para executar algumas consultas de exemplo e testar a conectividade com o servidor API Cato Networks.

Visão Geral do GraphQL Playground

O GraphQL Playground permite que você execute consultas API que são enviadas diretamente ao servidor API Cato. Softwares de consulta API de terceiros, como Altair ou Postman, oferecem funcionalidades poderosas para executar chamadas API. No entanto, se houver um problema de conectividade com consultas API, você pode usar o Playground para ajudar a identificar a causa do problema.

Pré-requisitos para Consultas API Cato com o GraphQL Playground

Para executar uma consulta API Cato a partir do GraphQL Playground, você deve ter a Chave API para sua conta (Administração > API & Integrações). Para mais informações sobre as Chaves API, consulte Gerando Chaves API para a API Cato.

As consultas de exemplo também exigem que você insira o ID da Aplicação de Gerenciamento Cato para sua conta. Esse ID da Conta não é mostrado no Aplicativo de Gerenciamento Cato, em vez disso, ele é o número na URL para o Aplicativo de Gerenciamento Cato. Por exemplo, o ID da Conta é 26 para o seguinte URL: https://cc.catonetworks.com/#!/26/topology.

Testando Conectividade com Consultas de Exemplo da API Cato

Você pode executar uma consulta API de exemplo para testar a conectividade com o servidor API Cato. Quando o argumento ID da Conta e a Chave API estão configurados corretamente, então a consulta API de exemplo 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 API ou o servidor pode estar fora do ar.

As seguintes consultas API de exemplo podem ajudá-lo a testar a conectividade com o servidor API Cato:

• accountMetrics
• accountSnapshot

Para mais informações sobre a solução de problemas com a API Cato, consulte Solução de Problemas com Chamadas API Cato.

Executando uma Consulta API de Exemplo no GraphQL Playground

Use um navegador de 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 exemplo no painel esquerdo e insira seu ID da Conta. Então, você pode executar a consulta e ver os resultados no Playground.

Para executar uma consulta API de exemplo:

1. Baixe uma das consultas API de exemplo deste artigo e abra o arquivo em um editor de texto, como o Bloco de Notas.
2. A partir de um navegador de Internet, acesse o GraphQL Playground para a API Cato: https://api.catonetworks.com/api/v1/graphql2.
3. Na parte inferior do painel esquerdo, clique em HTTP HEADERS.
4. Insira sua Chave API neste formato: { "x-api-key" :"<chave api>" }.

   A captura de tela a seguir mostra o cabeçalho HTTP configurado com a Chave API AaBbCcDdEeFf0123456789ABCDEF1234:

   

5. Copie e cole uma das consultas de exemplo no painel esquerdo do Playground.
6. No topo da consulta, no argumento id, insira seu ID da Conta.

   A captura de tela a seguir mostra o argumento ID configurado com o valor 2626:

   

7. Clique no botão de reprodução.

   O painel à direita mostra os resultados da consulta API. A captura de tela a seguir mostra os resultados para a consulta de exemplo accountMetrics para o ID da Conta 2626: