Als u nog niet bekend bent met het concept van variabelen, raden we u aan het artikel Variabelen te lezen om een overzicht te krijgen van hoe het werkt. Dit artikel geeft een overzicht van voorgedefinieerde variabelen en hoe u deze kunt gebruiken en instellen in een Multi-step API-controleregel.
Voorgedefinieerde variabelen
Met voorgedefinieerde variabelen kunt u waarden uit HTTP-responses vastleggen en opslaan, of uw eigen waarden opgeven aan het begin van een API-scenario. Onder de stap-editor vindt u een extra sectie waar u deze variabelen kunt specificeren.
Zoals te zien is in de afbeelding, bevat de variabele {{BaseUrl}} de waarde https://galacticresorts.com. In plaats van voor elke stap steeds weer URL’s te definiëren, kunt u de variabele gemakkelijk gebruiken om verschillende eindpunten voor elke stap te targeten, zoals {{BaseUrl}}/Products en {{BaseUrl}}/Status. U kunt ook van de ene omgeving naar de andere schakelen door gewoon de waarde van de variabele bij te werken naar https://test-galacticresorts.com.
Een andere veelvoorkomende gebruikssituatie voor voorgedefinieerde variabelen is het opslaan van uw API-key voor authenticatie. Door uw inloggegevens als variabele te definiëren, kunt u gevoelige informatie veilig beheren en de waarde op één plek bijwerken wanneer dat nodig is. U kunt ook Vault-inloggegevens gebruiken als voorgedefinieerde variabelen.
Voorgedefinieerde variabelen instellen
Om een voorgedefinieerde variabele toe te voegen doet u het volgende:
- Ga onder de Visuele stap-editor naar Voorgedefinieerde variabelen.
- Klik op .
- Geef de variabelenaam op in het veld Naam. Bijvoorbeeld:
BaseUrl. - Klik op en selecteer een waarde. Dit kan platte tekst zijn of een gebruikersnaam of wachtwoord uit de vault.
- Geef de waarde van de variabele op. Bijvoorbeeld:
https://test.yourapi.com.
Nadat u de variabele heeft gecreëerd, kunt u deze gebruiken voor uw API-stappen met de syntaxis: {{VariableName}}. Als u ernaar wilt verwijzen als de base-URL voor elke API-stap, kunt u: {{BaseURL}}/UserService/GetUserInfo of {{BaseURL}}/UserService/GetProductInfo gebruiken. Op deze manier kunt u de waarde van de variabele eenvoudig bijwerken om naar een andere omgeving te verwijzen, zoals staging of production, zonder elke stap te hoeven bewerken.
Vault-inloggegevens als voorgedefinieerde variabelen gebruiken
Voorgedefinieerde variabelen kunnen ook gevoelige informatie opslaan en deze overal in het API-scenario gebruiken. Als uw API authenticatie vereist, zoals inloggen of het ophalen van een toegangstoken, kunt u een variabele gebruiken om uw inloggegevens op te slaan en deze in uw requests gebruiken.
Uptrends beschikt over de Vault, waar u gevoelige data veilig kunt opslaan in uw Uptrends-account.
Om vault-inloggegevens als voorgedefinieerde variabele te gebruiken doet u het volgende:
- Zorg ervoor dat u uw inloggegevens heeft toegevoegd aan de Uptrends Vault.
- Stel een voorgedefinieerde variabele in.
- Klik op .
- Selecteer Vault-inloggegevens.
- Selecteer een set inloggegevens samen met de waarde. Bijvoorbeeld, selecteer een combinatie van gebruikersnaam en wachtwoord.
- Klik op Selecteren.
Nadat de variabele is gecreëerd, kunt u deze gebruiken voor uw API-stappen. In het voorbeeld werden de inloggegevens gebruikt in de Response headers. In de Details van de controle-resultaten zijn de waarden gemaskeerd om de gevoelige data verborgen te houden.
