Postman API-variabelen

Als u net begint met Postman API-monitoring, raden we u aan het overzichtsartikel Postman API Monitoring te lezen zodat u de belangrijkste kenmerken en functies weet.

In dit artikel wordt uitgelegd hoe variabelen uit uw Postman-collectie worden vastgelegd en hoe u hun waarden kunt invullen voor gebruik in het volledige API-scenario.

Variabelen

Variabelen in Postman worden gebruikt om waarden op te slaan en te hergebruiken in verschillende requests, scripts en omgevingen. Ze helpen u bij het beheren van dynamische data, zoals authenticatietokens, API-sleutels of andere waarden die in de loop van de tijd of tussen verschillende omgevingen kunnen veranderen.

Wanneer u een Postman-collectie importeert die variabelen zoals {{VariableName}} gebruikt in requests, scripts of omgevingen, detecteert en toont de Postman API-controleregel deze variabelen automatisch als [voorgedefinieerde variabelen voor u. Deze variabelen worden vermeld in de sectie Variabelen van de controleregel-editor en u hoeft alleen hun waarde in te vullen. Dit is handig voor gemakkelijke authenticatie met API’s die een gebruikersnaam, wachtwoord of geheime sleutel vereisen.

Gebruiksscenario

Stel dat u een Postman-collectie met een API-eindpunt heeft geïmporteerd: GET {{baseUrl}}/{{secretkey}}/.... Met deze GET-request kunt u zich vanuit verschillende omgevingen authenticeren door uw geheime sleutel als inloggegevens te gebruiken.

Als onderdeel van de Requests herkent de controleregel dat er twee variabelen, {{baseUrl}} en {{secretkey}, zijn gedefinieerd in uw collectie. Deze variabelen worden automatisch gecreëerd en weergegeven in de Variabelen van de controleregel-editor. U kunt hun waarden eenvoudig invullen of meer variabelen toevoegen op basis van uw monitoringvereisten.

Zoals te zien is in de afbeelding, zijn er vier variabelen gecreëerd: twee automatisch door de controleregel en twee zijn door u gedefinieerd.

• De prodEnvironment en testEnvironment zijn door de gebruiker gedefinieerde variabelen die productie- en testomgeving-URL’s opslaan. Deze worden handmatig toegevoegd en kunnen in het gehele API-scenario worden gebruikt met behulp van de syntaxis {{VariableName}}.
• De variabele baseUrl is automatisch gegenereerd en geïdentificeerd door de controleregel. Zijn waarde is ingesteld op {{prodEnvironment}} zodat hij in de productieomgeving kan worden gebruikt. Als u in de testomgeving wilt testen, vervangt u {{prodEnvironment}} door {{testEnvironment}}. Zo kunt u snel schakelen tussen omgevingen zonder uw collectie of afzonderlijke requests handmatig aan te passen.
• De variabele secretkey is automatisch gegenereerd en geïdentificeerd door de controleregel. Deze bevat een waarde uit de Vault, specifiek een wachtwoord uit een set inloggegevens.

Variabelen instellen

Nadat u uw Postman-collectie heeft geïmporteerd, kunt u waarden aan variabelen toewijzen met platte tekst of via de Vault.

Waarden toewijzen aan variabelen met platte tekst

Om waarden aan variabelen toe te wijzen met platte tekst doet u het volgende:

1. Ga naar Variabelen.
2. Identificeer de variabele waaraan u een waarde wilt toewijzen. Klik op .
3. Selecteer Platte tekst.
4. Geef een tekst of variabele op in het veld Platte tekst. Bijvoorbeeld https://test.yourapi.com of {{VariableName}}.
5. Klik op Selecteren.

Elke keer dat uw controleregel wordt uitgevoerd en een variabele tegenkomt, gebruikt deze de door u opgegeven waarde. Als u de baseUrl instelt op https://test.yourapi.com, wordt de API-request verzonden naar https://test.yourapi.com/.... Als u de secretkey instelt op {{secretKeyVariable}}, wordt de waarde van die variabele gebruikt.

Waarden toewijzen aan variabelen door vault-items te gebruiken

Variabelen kunnen ook vault-items opslaan, die gevoelige informatie uit de Uptrends Vault bevatten.

Om waarden toe te wijzen aan variabelen met behulp van kluisitems doet u het volgende:

1. Zorg ervoor dat u uw inloggegevens heeft toegevoegd aan de Uptrends Vault.
2. Identificeer de variabele waaraan u een waarde wilt toewijzen. Klik op .
3. Selecteer Vault-inloggegevens.
4. Selecteer een set inloggegevens met de bijbehorende waarde. Selecteer bijvoorbeeld een gebruikersnaam of wachtwoord.
5. Klik op Selecteren.

Telkens wanneer uw controleregel wordt uitgevoerd en een variabele tegenkomt, wordt de door u opgegeven waarde gebruikt. Als u het wachtwoord uit uw set inloggegevens gebruikt, bevat {{secretkey}} de waarde Wachtwoord uit de vault.