Cet article explique comment utiliser le client d'API Postman et exécuter les API de Cato pour provisionner des sites dans l'application de gestion Cato.
Il s'agit d'une vue d'ensemble de haut niveau de la configuration de Postman pour exécuter l'API de configuration de Cato pour provisionner et mettre à jour des sites.
-
Générez la clé API à partir de l'application de gestion Cato.
-
Téléchargez et importez la collection et l'environnement Postman.
-
Configurez l'environnement.
-
Exécutez l'API et provisionnez des sites dans le compte.
La clé API est un code que le client API utilise pour s'authentifier avec votre compte Cato. Vous pouvez utiliser l'écran de gestion des API dans l'application de gestion Cato pour générer une clé API avec des autorisations de modification.
Pour générer une clé API pour l'API de Création de Cato :
-
Dans le menu de navigation, cliquez sur Ressources > API Keys.
-
Sous l'onglet API Keys, cliquez sur Nouveau. Le panneau Créer une clé API s'ouvre.
-
Entrez le Nom de la clé.
-
Définissez les Autorisations API sur Modifier.
-
Nous recommandons de définir une date d'expiration pour la clé API à Expiration le.
-
Cliquez sur Appliquer. La clé API est ajoutée et une fenêtre contextuelle contenant la nouvelle clé API s'affiche.
-
Cliquez sur
(Copier) et copiez la Clé API générée par l'application de gestion Cato et enregistrez-la dans un emplacement sécurisé.
Une fois que vous fermez cette fenêtre, vous ne pouvez plus accéder à la valeur de la clé API.
-
Cliquez sur OK pour fermer la fenêtre contextuelle.
Nous avons créé une collection et un environnement personnalisés Postman pour vous aider à démarrer la création de sites avec l'API de Création de Cato. Ces fichiers personnalisés sont disponibles dans le référentiel Cato.
- _cato_env_template_.postman_environment.json
- Fichiers API de mutation pour l'API de configuration (tels que Cato Site Mutation API v1.postman_collection.json)
L'environnement Postman contient des variables (URL API, ID de compte CMA, etc.) et la collection Postman contient des exemples d'appels GraphQL Mutation API. Pour les importer, cliquez sur « Importer », déposez le fichier dans la fenêtre et cliquez sur importer :
Pour ajouter la collection et l'environnement de l'API Cato à Postman :
-
Téléchargez la collection et les environnements personnalisés de cet article de la base de connaissances sur votre appareil.
-
Depuis Postman, sélectionnez Fichier > Importer. La fenêtre contextuelle Importer s'ouvre.
-
Cliquez sur Télécharger des fichiers, puis sélectionnez les fichiers téléchargés à l'étape 1.
-
Cliquez sur Importer.
L'environnement personnalisé est maintenant affiché dans Environnements de Postman :
La collection personnalisée est maintenant affichée dans les Collections de Postman :
Nous vous recommandons d'utiliser un environnement Postman distinct pour chaque locataire Cato où vous stockez l'ID de compte CMA et la clé API.
Pour créer un nouvel environnement Postman :
-
Depuis l'onglet Environnement, faites un clic droit sur le modèle _cat_env_template_ et sélectionnez Dupliquer.
-
Faites un clic droit sur la copie de l'environnement, sélectionnez Renommer, puis renommez l'environnement avec le nom de votre locataire Cato.
-
Copiez la Clé API et l'ID de compte CMA, et collez-les dans la Valeur actuelle des champs pertinents dans l'environnement et cliquez sur Enregistrer.
Vous pouvez récupérer l'ID de compte CMA directement depuis l'URL :
Après avoir défini la clé API et l'ID de compte CMA pour Postman
Pour exécuter l'appel API et provisionner des sites :
-
Sur l'onglet Collections.
-
Dans le coin supérieur droit, sélectionnez l'environnement que vous avez créé à l'étape précédente.
-
Depuis l'onglet Collections, développez Cato Mutation API v1 > addSocketSite > _query et sélectionnez query_stateCode.
-
Cliquez sur Envoyer pour exécuter l'appel API. Le résultat attendu est 200 OK et quelques données.
0 commentaire
Vous devez vous connecter pour laisser un commentaire.