Een API (application programming interface) is software die de communicatie tussen applicaties mogelijk maakt. Misschien gebruikt u uw eigen API’s en/of vertrouwt u op API’s van derden. Hoe dan ook, het correct functioneren van de API’s is cruciaal voor de werking van uw website en diensten, daarom moet u ze monitoren.
API Monitoring controleert of de API’s waarop u vertrouwt beschikbaar zijn, correct functioneren en goed presteren. Meer informatie is te vinden in het artikel Wat is API Monitoring?.
Uptrends API Monitoring biedt verschillende types controleregels om API Monitoring te configureren. Welk type u kiest, hangt af van of u te maken heeft met een enkele stap of met een keten van requests die uit meerdere stappen bestaat. De eenstaps-controleregel wordt gedefinieerd met het controleregeltype Webservice HTTP of Webservice HTTPS. De controleregel voor een reeks stappen wordt gedefinieerd met het controleregeltype Multi-step API (MSA-controleregel).
De Uptrends-app heeft een Multi-step API-controleregel hub waar informatie over deze controleregels en de huidige status op één plek zijn te vinden.
API-controleregels configureren
De configuratie van de verschillende types controleregels wordt beschreven in deze artikelen:
- Web Services Monitoring configureren
- Web Services Monitoring configureren (SOAP)
- Multi-step API Monitoring configureren
Multi-step API-controleregelstappen definiëren
Bij het instellen van een Multi-step API-controleregel moet u de stappen definiëren die de HTTP-requests bevatten die deel uitmaken van het scenario dat u wilt monitoren. Voor elke stap moet u de details voor het request- en responsegedeelte van de stap instellen. Er zijn ook enkele definities voor gebruiker-gedefinieerde functies, variabelen en kengetallen. Deze zijn globaal ingesteld (beschikbaar voor alle stappen). Bekijk de artikelen in de onderstaande secties voor meer informatie over het instellen van de HTTP-stappen.
Request
De HTTP-staprequest wordt ingesteld door een methode en een URL en de requestbody van de request te verstrekken, en vervolgens verdere details zoals de authenticatie te specificeren. Zie onderstaande artikelen voor meer informatie.
Response
Binnen de response van de stap moet u assertions definiëren. Assertions zijn controles die één stap verder gaan dan de vraag of er een response op de request komt. Een assertion controleert ook of de response geldig is of op tijd arriveert. Voor elke stap kunt u een aantal assertions definiëren. Meer informatie over assertions vindt u in deze artikelen:
- Assertions - Inleiding
- Assertions - Bronnen
- Assertions - Vergelijkingsoperatoren
- Assertions - Voorbeelden met XPath
- Variabelen
- Redirects afhandelen
Globale definities
Er zijn een aantal dingen die u kunt definiëren voor alle stappen en zowel het request- als het responsegedeelte ervan. Dit is handig als u een bepaalde waarde of functie in verschillende stappen wilt gebruiken. Lees verder in de volgende artikelen voor meer informatie:
- Voorgedefinieerde variabelen
- Door de gebruiker gedefinieerde functies
- Vrije kengetallen
- Hashing en codering
Scriptweergave
U kunt de stapdefinities van Multi-step API-controleregels ook rechtstreeks in de scriptweergave bewerken. Bekijk ons artikel over de MSA-scripteditor voor meer informatie.