Postman configureren om API's uit te voeren op vManage

Inleiding

In dit document wordt beschreven hoe u Application Programming Interfaces (API's) met Postman kunt uitvoeren.

Systeemvereisten

• Postbode geïnstalleerd
• Toegang tot vManage en gebruikersnaam en wachtwoord referenties

Opmerking: Als je geen Postman hebt, download het dan van https://www.postman.com/downloads/

Achtergrondinformatie

De primaire of meest gebruikte HTTP-werkwoorden (of methoden, zoals ze correct worden genoemd) zijn POST, GET, PUT, PATCH en DELETE.

Deze komen overeen met het maken, lezen, bijwerken en verwijderen (of CRUD) operaties, respectievelijk.

Er zijn ook een aantal andere werkwoorden, maar deze worden minder vaak gebruikt. Van die minder frequente methoden worden OPTIONS en HEAD vaker gebruikt dan andere.

Postman configureren om de API's uit te voeren

Stap 1. Open Postman en maak een nieuw HTTP-verzoek aan.

U kunt nieuwe HTTP-verzoeken maken als u op een van de gemarkeerde opties klikt.

Maak een nieuw HTTP-verzoek aan.

Stap 2. Verifieer met uw gebruikersnaam en wachtwoordreferenties naar vManage.

Maak een ander HTTP-verzoek aan.

1. Selecteer POST als je HTTP-werkwoord.
2. Voeg https://<vmanage-ip>/j_security_check toe naast POST.
3. Klik op Body en voeg als KEY parameters j_username en j_password en hun waarden respectievelijk toe.
4. Klik op Verzenden.

Opmerking: in dit voorbeeld is het vManage-IP-adres 10.88.244.30 en de poort 5301

Opmerking: Als gebruikersnaam en wachtwoord gebruiken we admin.

Voldoen aan de parameters in Postman.

vManage-verificatie.

Let op: Het antwoord van deze API-oproep moet leeg zijn

Stap 3. Een token aanvragen

1. Selecteer GET als uw HTTP-werkwoord.
2. Voeg de API-aanroepgegevens toe naast GET https://<vmanage-ip>/dataservice/client/token
3. Klik op Verzenden

Opmerking: Sinds vManage versie 19.2.1 is het verplicht dat een met succes ingelogde gebruiker X-XSRG-TOKEN of CSRF-token moet verzenden voor elke POST / PUT / DELETE-bewerking via API-oproep.

Zodra de API-aanroep is uitgevoerd, krijgt u een antwoordreeks in het lichaam. Sla die string op. De getoonde afbeelding is een voorbeeld van de uitvoer In Postman.

Een token aanvragen voor vManage

Waarschuwing: Als u geen token hebt ontvangen zoals in de afbeelding wordt weergegeven, herhaalt u de stap.

Stap 4. Ga verder met het uitvoeren van een andere API naar vManage.

Dit voorbeeld bevat een POST-verzoek

1. Selecteer de API-aanroep die moet worden uitgevoerd, in ons geval is dit https:///dataservice/statistics/dpi/aggregation

Tip: Als u andere API-oproepen wilt verkennen, gaat u naar vManage-URL https://vmanage-ip:port/apidocs

2. Verzamel uw API call body.

Opmerking: Deze API-oproep bevat een body in JSON-indeling

3. Klik op Header en voeg als sleutel de tekenreeks X-XSRF-TOKEN als waarde toe.

4. Klik op Verzenden.

In de afbeelding wordt weergegeven hoe uw API-aanroep moet worden weergegeven.

DPI-aggregatie API-oproep.

Stap 5. Sluit uw sessie

Zodra u alle benodigde informatie van vManage en/of de apparaten hebt opgehaald, kunt u de bronnen van vManage vrijmaken en de mogelijkheid voor kwaadwillende gebruikers om uw sessie te gebruiken, elimineren.

API-oproepen uitvoeren in een geautomatiseerde omgeving

Sla cookies en variabelen op voor gebruik in volgende API-oproepen

Hoe kan ik token opslaan in een variabele?

Sla de token op in een variabele voor later hergebruik.

De token opslaan in een variabele

Wanneer we het token in JSON-formaat aanvragen, slaat u het op. Gebruik het tabblad Tests en plak de getoonde regels.

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

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