Connexion à l'API Cato depuis le GraphQL Playground

Cet article explique comment utiliser le GraphQL Playground pour exécuter des requêtes d'exemple et tester la connectivité au point de terminaison de l'API Cato Networks.

Vue d'ensemble de GraphQL Playground

Le GraphQL Playground vous permet d'exécuter des requêtes d'API envoyées directement au serveur API Cato. Des logiciels de requête API tiers tels que Altair ou Postman offrent des fonctionnalités puissantes pour exécuter des appels d'API. Cependant, s'il y a un problème de connectivité avec les requêtes API, vous pouvez utiliser le Playground pour vous aider à identifier la cause du problème.

Prérequis

Pour exécuter une requête API Cato depuis le GraphQL Playground, vous devez avoir la clé API de votre compte (Ressources > Clés API). Pour plus d'informations sur les clés API, voir Génération de clés API pour l'API Cato.

Vous devez entrer l'ID de l'application de gestion Cato (CMA) pour votre compte dans les requêtes d'exemple. Vous pouvez trouver l'ID CMA sur la page des informations du compte.

L'URL pour le point de terminaison de l'API est spécifique à l'emplacement où l'instance de l'application de gestion Cato (CMA) est hébergée. Il peut y avoir une valeur <préfixe> qui est ajoutée à l'URL pour votre compte CMA et au point de terminaison de l'API.

  • S'il n'y a pas de préfixe (cc.catonetworks.com), utilisez alors l'URL suivante : https://api.catonetworks.com/api/v1/graphql2

  • S'il y a un préfixe (tel que cc.us1.catonetworks.com), vous utilisez alors l'URL suivante : https://api.us1.catonetworks.com/api/v1/graphql2

Test de la connectivité avec des requêtes API Cato d'exemple

Vous pouvez exécuter une requête API d'exemple pour tester la connectivité au serveur API Cato. Lorsque l'argument accountID et la clé API sont configurés correctement, la requête API d'exemple retourne les données du compte et affiche les résultats dans le GraphQL Playground. Si la requête ne retourne pas de résultats pour votre compte, il peut alors y avoir un problème de connectivité avec le serveur API ou le serveur peut être hors ligne. Les requêtes API d'exemple suivantes peuvent vous aider à tester la connectivité au serveur API Cato :

Exécution d'une requête API d'exemple dans GraphQL Playground

Utilisez un navigateur Internet pour ouvrir le GraphQL Playground pour l'API Cato. Configurez l'en-tête HTTP pour le Playground avec votre clé API. Collez la requête d'exemple dans le volet de gauche et entrez votre ID de compte. Ensuite, vous pouvez exécuter la requête et voir les résultats dans le Playground.

  1. Téléchargez une des requêtes API d'exemple de cet article et ouvrez le fichier dans un éditeur de texte tel que Notepad.

  2. Depuis un navigateur Internet, allez sur le GraphQL Playground pour l'API Cato.

  3. En bas du volet de gauche, cliquez sur EN-TÊTES HTTP.

  4. Entrez votre clé API dans ce format : { "x-api-key" :"<clé api>" }.

    La capture d'écran suivante montre l'en-tête HTTP configuré avec la clé APIAaBbCcDdEeFf0123456789ABCDEF1234 :

    graphql1.png

  5. Copiez et collez une des requêtes d'exemple dans le volet de gauche du Playground.

  6. En haut de la requête, dans l'argument accountID, entrez votre ID de compte.

    La capture d'écran suivante montre l'argument accountID configuré avec la valeur 2626 :

    graphql2.png

  7. Cliquez sur le bouton de lecture.

  8. Le volet de droite montre les résultats de la requête API. La capture d'écran suivante montre les résultats pour la requête accountMetrics d'exemple pour l'ID du compte 2626 :

    graphql3.png

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 2 sur 3

0 commentaire