Een Multi-step API-controleregel bestaat uit stappen. Voor elke stap kunt u zowel de HTTP-request- als responsecomponenten configureren. Dit artikel geeft u een overzicht van hoe een API-response werkt in een multi-step API- controleregel. U leert welke HTTP-responsedefinities beschikbaar zijn en hoe u deze instelt.
Response
Binnen een stap ziet u het tabblad Response. Hier kunt u controles en validaties instellen om het gedrag van de API-response te verifiëren.
Assertions
Assertions zijn de specifieke voorwaarden die u kunt instellen om de API-response te valideren. Een assertion controleert of de API de juiste data, statuscodes, headers, responsetijd en meer retourneert.
Voor elke stap kunt u een aantal assertions definiëren, afhankelijk van uw monitoringvereisten. Het definiëren van een assertion omvat de volgende componenten:
Raadpleeg voor meer informatie Multi-step API Assertions.
Variabelen
Bij het opzetten van multi-step API-scenario’s moet u mogelijk specifieke data uit eerdere stappen vastleggen en doorgeven aan de volgende stappen. In stap één voert uw API bijvoorbeeld een GET request uit om een ID op te halen. In stap twee heeft u diezelfde ID nodig als queryparameter voor de API-call.
In dergelijke scenario’s kunt u variabelen gebruiken om waarden uit HTTP-responses te extraheren en deze op te slaan voor hergebruik in het gehele API-scenario. Door die waarde vast te leggen, tijdelijk op te slaan en mee te nemen naar de volgende stappen, creëert u een natuurlijke voortgang van verbonden stappen, zonder dat u code hoeft te schrijven.
Voor elke stap kunt u variabelen creëren. Dit kunnen waarden zijn die zijn opgehaald uit JSON- of XML-data, response headers of data uit een
redirect, en meer. Nadat ze zijn gedefinieerd, kunt u deze gebruiken als onderdeel van uw multi-step-configuratie met de syntaxis {{my-variable}}.
Raadpleeg voor meer informatie Multi-step API Variabelen.
Maximaal aantal pogingen
Er zijn gevallen waarin een API-request mogelijk extra tijd nodig heeft om het proces te voltooien voordat een succesvolle response wordt geretourneerd. Voorbeelden hiervan zijn: wachten op het uploaden van een bestand, het slagen van een betalingstransactie of het ontvangen van een e-mailverificatie. Er zijn ook gevallen waarin een API-request of een assertion kan mislukken vanwege externe problemen, zoals een slechte netwerkverbinding of onverwachte downtime. In deze situaties kunt u Maximaal aantal pogingen inschakelen om automatisch dezelfde stap opnieuw uit te voeren.
Door dezelfde stap herhaaldelijk opnieuw uit te voeren, geeft dit de controleregel het signaal dat de stap zich in een wachtstatus bevindt en opnieuw moet worden gecontroleerd en niet als een fout moet worden behandeld. Dit helpt ook bij het meten van de duur van het achtergrondproces.
U kunt tussen 2 en 50 nieuwe pogingen configureren en de vertraging tussen elke poging in milliseconden specificeren. Raadpleeg Maximaal aantal pogingen voor meer informatie.
Aangepaste scripting
De onderdelen request en response van een stap kunnen optioneel worden uitgebreid met Aangepaste scripting in de tabbladen Pre-Request en Post-Response. Hiermee kunt u scripts uitvoeren die in JavaScript zijn geschreven om aangepaste logica uit te voeren en diepgaande functionele tests uit te voeren. Naast de volledige reeks mogelijkheden die de standaard JavaScript biedt, kunt u ook Snippets gebruiken. Dit zijn voorgedefinieerde scripts van Uptrends waarmee u de correcte functionaliteit en het gedrag van uw API’s kunt verifiëren.