Table des matières

Introduction

Conditions préalables

Exigences

Composants utilisés

Documentation de l'API AccessOnboard

Tester les API à partir de l'outil de documentation

Informations connexes

Introduction

Ce document décrit comment valider et configurer les appels de l'API REST vers vManage à l'aide de la documentation intégrée.

Conditions préalables

Exigences

Aucune exigence spécifique n'est associée à ce document.

Composants utilisés

Ce document n'est pas limité à des versions logicielles ou à des types de déploiement vManage spécifiques.

The information in this document was created from the devices in a specific lab environment. All of the devices used in this document started with a cleared (default) configuration. Si votre réseau est en ligne, assurez-vous de bien comprendre l’incidence possible des commandes.

Accéder à la documentation API intégrée

La documentation de l'API intégrée vManage se trouve à l'adresse URL https://<vmanage_ip>:<port:>/apidocs.  Cette documentation affiche les API disponibles sur la version actuelle du logiciel.

Cela nécessite une connexion avec des informations d'identification vManage valides.  Bien que plusieurs niveaux de privilèges puissent afficher la documentation, seul un utilisateur netadmin peut les exécuter tous.

Remarque : la page de documentation de l'API est disponible pour les locataires dans un environnement multilocataire. Toutefois, certaines commandes sont réservées au fournisseur.

vManage affiche ensuite la liste des catégories d'API disponibles.  Cliquez sur la catégorie souhaitée, puis sur l'appel d'API proprement dit, qui affiche les champs suivants :

Description/Notes de mise en oeuvre

Description de l'opération effectuée.

Paramètres

Paramètres requis à spécifier pour l'appel d'API.

Corps de la demande (POST/PUT/DELETE)

Format du corps de la demande.

Réponses

Réponses possibles que vManage envoie à l'API. Cela inclut le code d'état HTTP, la raison et le corps de réponse possible.

Extensions

Postes valides pour l'appel.

Tester les API à partir de l'outil de documentation

Les API disponibles peuvent être testées via l'option Try It Out.

Remarque : sachez qu'il ne s'agit pas d'une simulation. L'appel est en fait exécuté sur le vManage local.  Planifiez en conséquence tout impact associé.

1. Cliquez sur le bouton Try It Out.

2. Entrez tous les paramètres requis.

3. Cliquez sur Exécuter.

Cette commande exécute la tâche d'API et renvoie la réponse reçue de vManage, qui comprend les champs suivants :

URL de demande

URL complète utilisée, qui inclut l'adresse vManage et tous les paramètres entrés.  Cette option peut être utilisée par les scripts ou utilitaires appropriés qui ont authentifié les sessions avec succès.

Organisme D'Intervention

Données de réponse complètes reçues.

Code réponse

Code d'état HTTP reçu.

En-têtes de réponse

En-têtes utilisés.

Informations connexes

Documentation de l'API vManage pour développeurs Cisco