Konfigurieren von Postman zur Ausführung von APIs in vManage

Einleitung

In diesem Dokument wird beschrieben, wie Application Programming Interfaces (APIs) mit Postman ausgeführt werden.

Systemanforderungen

• Postman installiert
• Zugriff auf vManage sowie Benutzername- und Passwortanmeldeinformationen

Hinweis: Wenn Sie Postman nicht haben, laden Sie es unter https://www.postman.com/downloads/ herunter.

Hintergrundinformationen

Die primären oder am häufigsten verwendeten HTTP-Verben (oder Methoden, wie sie richtig genannt werden) sind POST, GET, PUT, PATCH und DELETE.

Diese beziehen sich auf die Vorgänge zum Erstellen, Lesen, Aktualisieren und Löschen (bzw. CRUD).

Es gibt noch eine Reihe anderer Verben, die aber seltener verwendet werden. Von diesen selteneren Methoden werden OPTIONS und HEAD häufiger verwendet als andere.

Konfigurieren von Postman zum Ausführen der APIs

Schritt 1: Öffnen Sie Postman, und erstellen Sie eine neue HTTP-Anfrage.

Sie können eine neue HTTP-Anfrage erstellen, wenn Sie auf eine der hervorgehobenen Optionen klicken.

Erstellen Sie eine neue HTTP-Anforderung.

Schritt 2: Melden Sie sich mit Ihrem Benutzernamen und Ihrem Kennwort bei vManage an.

Erstellen Sie eine weitere HTTP-Anforderung.

1. Wählen Sie POST als HTTP-Verb aus.
2. Fügen Sie https://<vmanage-ip>/j_security_check neben POST hinzu.
3. Klicken Sie auf Body, und fügen Sie die j_username- und die j_password-Parameter und deren Werte als KEY-Parameter hinzu.
4. Klicken Sie auf Senden.

Hinweis: In diesem Beispiel lautet die vManage-IP-Adresse 10.88.244.30, und der Port ist 5301.

Hinweis: Als Benutzername und Kennwort verwenden wir admin.

Erfüllen Sie die Parameter in Postman.

vManage-Authentifizierung.

Achtung: Die Antwort dieses API-Aufrufs muss leer sein.

Schritt 3: Anfordern eines Tokens

1. Wählen Sie GET als HTTP-Verb aus.
2. Fügen Sie die API-Anrufdetails neben GET https://<vmanage-ip>/dataservice/client/token hinzu.
3. Klicken Sie auf Senden

Hinweis: Seit vManage-Version 19.2.1 ist es zwingend erforderlich, dass ein erfolgreich angemeldeter Benutzer X-XSRG-TOKEN oder CSRF-Token für jeden POST-/PUT-/DELETE-Vorgang per API-Aufruf senden muss.

Sobald der API-Aufruf ausgeführt wurde, wird eine Antwortzeichenfolge im Text ausgegeben. Speichern Sie diese Zeichenfolge. Das abgebildete Bild veranschaulicht die Ausgabe von In Postman.

Anfordern eines Tokens für vManage

Warnung: Wenn Sie keinen Token erhalten haben, wie im Bild dargestellt, wiederholen Sie bitte den Schritt.

Schritt 4: Fahren Sie mit der Ausführung einer weiteren API für vManage fort.

Bei diesem Beispiel handelt es sich um eine POST-Anforderung.

1. Wählen Sie den auszuführenden API-Aufruf aus, in unserem Fall ist dies https:///dataservice/statistics/dpi/aggregation

Tipp: Weitere API-Aufrufe finden Sie unter vManage url https://vmanage-ip:port/apidocs

2. Erfassen Sie Ihren API-Aufruftext.

Hinweis: Dieser API-Aufruf enthält einen Text im JSON-Format.

3. Klicken Sie auf Header und fügen Sie als Schlüssel die Zeichenfolge X-XSRF-TOKEN als Wert hinzu.

4. Klicken Sie auf Senden.

Das dargestellte Bild zeigt, wie der API-Aufruf angezeigt werden muss.

DPI-Aggregation-API-Aufruf.

Schritt 5: Sitzung schließen

Sobald Sie alle erforderlichen Informationen von vManage und/oder den Geräten abgerufen haben, geben Sie Ressourcen von vManage frei und verhindern, dass böswillige Benutzer Ihre Sitzung verwenden können.

Ausführung von API-Aufrufen in einer automatisierten Umgebung

Speichern von Cookies und Variablen, die in nachfolgenden API-Aufrufen verwendet werden sollen

Wie speichert man Token in einer Variablen?

Speichern Sie das Token in einer Variablen zur späteren Wiederverwendung.

Speichern des Tokens in einer Variablen

Wenn wir das Token im JSON-Format anfordern, speichern Sie es. Verwenden Sie die Registerkarte Tests, und fügen Sie die angezeigten Zeilen ein.

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

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