Configurer Postman pour exécuter des API sur vManage

Introduction

Ce document décrit comment exécuter des API (Application Programming Interfaces) avec Postman.

Configuration système nécessaire

• Facteur installé
• Accès à vManage et identifiants de nom d'utilisateur et de mot de passe

Remarque : si vous n'avez pas Postman, téléchargez-le sur https://www.postman.com/downloads/

Informations générales

Les verbes HTTP principaux ou les plus couramment utilisés (ou méthodes, comme on les appelle) sont POST, GET, PUT, PATCH et DELETE.

Elles correspondent respectivement aux opérations de création, de lecture, de mise à jour et de suppression (ou CRUD).

Il y a aussi un certain nombre d'autres verbes, mais ils sont utilisés moins fréquemment. Parmi ces méthodes moins fréquentes, OPTIONS et HEAD sont utilisées plus souvent que d'autres.

Configurer Postman pour exécuter les API

Étape 1. Ouvrez Postman et créez une nouvelle requête HTTP.

Vous pouvez créer de nouvelles requêtes HTTP si vous cliquez sur l'une des options mises en surbrillance.

Créez une nouvelle requête HTTP.

Étape 2. Authentifiez-vous avec votre nom d'utilisateur et votre mot de passe pour vManage.

Créez une autre requête HTTP.

1. Sélectionnez POST comme verbe HTTP.
2. Ajoutez https://<vmanage-ip>/j_security_checknext à POST.
3. Cliquez sur Body et ajoutez en tant que KEY les paramètres j_username et j_password et leurs valeurs respectivement.
4. Cliquez sur Envoyer.

Remarque : dans cet exemple, l'adresse IP vManage est 10.88.244.30 et le port est 5301

Remarque : en tant que valeurs de nom d'utilisateur et de mot de passe, nous utilisons admin.

Complétez les paramètres dans Postman.

Authentification vManage.

Attention : la réponse de cet appel API doit être vide

Étape 3. Demander un jeton

1. Sélectionnez GET comme verbe HTTP.
2. Ajoutez les détails de l'appel API en regard de GET https://<vmanage-ip>/dataservice/client/token
3. Cliquez sur Envoyer

Remarque : depuis la version 19.2.1 de vManage, il est obligatoire qu'un utilisateur correctement connecté envoie un jeton X-XSRG-TOKEN ou CSRF pour chaque opération POST/PUT/DELETE via un appel d'API.

Une fois l'appel d'API exécuté, vous obtenez une chaîne de réponse dans le corps. Enregistrez cette chaîne. L'image illustrée illustre la sortie In Postman.

Demander un jeton pour vManage

Avertissement : si vous n'avez pas reçu de jeton, comme illustré dans l'image, répétez l'étape.

Étape 4. Exécutez une autre API pour vManage.

Cet exemple implique une requête POST

1. Sélectionnez l'appel API à exécuter, dans notre cas, https:///dataservice/statistics/dpi/aggregation

Conseil : si vous souhaitez explorer d'autres appels API, accédez à l'URL vManage https://vmanage-ip:port/apidocs

2. Collectez le corps de votre appel API.

Remarque : cet appel API contient un corps au format JSON

3. Cliquez sur Header et ajoutez comme Key la chaîne X-XSRF-TOKEN en tant que valeur.

4. Cliquez sur Envoyer.

L'image affichée indique comment votre appel d'API doit apparaître.

Appel API d'agrégation DPI.

Étape 5. Fermez votre session

Une fois que vous avez récupéré toutes les informations nécessaires à partir de vManage et/ou des périphériques, libérez des ressources de vManage et éliminez la possibilité pour des utilisateurs malveillants d'utiliser votre session.

Exécuter des appels API dans un environnement automatisé

Enregistrer les cookies et les variables à utiliser dans les appels API suivants

Comment enregistrer un jeton dans une variable ?

Enregistrez le jeton dans une variable pour une réutilisation ultérieure.

Enregistrer le jeton dans une variable

Lorsque nous demandons le jeton au format JSON, stockez-le. Utilisez l'onglet Tests et collez les lignes affichées.

var jsonData = JSON.parse(responseBody);
postman.setEnvironmentVariable("token", jsonData.token);

pm.test("Status code is 200", () => {
 pm.expect(pm.response.code).to.eql(200);
});