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.
Gerelateerde artikelen
-
Bronnen voor Multi-step monitoringHoe u waarden extraheert voor assertions of variabeletoewijzing bij het instellen van Multi-step API Monitoring.
-
Door de gebruiker gedefinieerde functiesEen overzicht van beschikbare gebruiker-gedefinieerde functies en hoe u deze kunt gebruiken
-
Hashing- en/of coderingswaardenIn bepaalde gebruikssituaties van API monitoring kan het nodig zijn om variabelen of waarden te hashen of te coderen. Autorisatie-instellingen kunnen bijvoorbeeld Base64-codering of HMAC-SHA256-hashing vereisen om correct te werken, of u moet mogelijk gecodeerde JSON opnemen in uw request body. Hiertoe biedt Uptrends verschillende opties voor codering en hashing, die in dit artikel worden beschreven. Coderen en decoderen Coderen is een proces om te verzekeren dat data op een betrouwbare manier, in een bepaalde vorm, kunnen worden verzonden.
-
Multi-step API monitoring configurerenStapsgewijze instructies voor het configureren van Multi-step API Monitoring.
-
Multi-step API-controleregel hubUw startpunt bij het verkennen van Multi-step API monitoring
-
Multi-step API-scripteditorEen overzicht van de scripteditor voor Multi-step API-controleregels
-
Multi-step cliëntcertificaten monitorenVeel API’s vereisen dat de caller authenticatie-informatie verstrekt om hun identiteit te verifiëren en mogelijk de toegangsrechten van die caller. Authenticatie-informatie kan worden doorgegeven met behulp van HTTP headers (Basic/NTLM/Digest-authenticatie), door uitwisselen van access tokens (OAuth), door de cliënt te verplichten een cliëntcertificaat op te nemen in de request, of een combinatie hiervan. In dit artikel worden de opties voor cliëntcertificaten besproken. Meer informatie over het instellen van traditionele authenticatiemethoden vindt u in het artikel over authenticatietypes.
-
Multi-step monitoringLeer hoe u met redirects werkt binnen uw Multi-step API-controleregels.
-
Multi-step monitoring AssertionsAssertions in Multi-step API monitoring begrijpen.
-
Multi-step monitoring authenticatieLeer meer over de beschikbare opties voor authenticatie bij gebruik van Multi-step API monitoring.
-
Multi-step monitoring XPath-voorbeeldenDit artikel bevat verschillende voorbeelden voor het extraheren van inhoud van XML-responses met behulp van XPath. Met deze XPath-query’s kunt u een XML-respons die terugkomt van uw API of webservice inspecteren als onderdeel van een Multi-step API-controleregel. Een XPath-query definieert welk deel van de XML-respons u interesseert - meestal een waarde die is opgenomen in een van de XML-nodes. U kunt dan die geëxtraheerde waarde nemen en (gebruikmakend van assertions) controleren of deze aan bepaalde voorwaarden voldoet of deze opslaan in een variabele voor later gebruik.
-
SOAP instellenAls u een SOAP-controleregel aan uw Uptrends-account wilt toevoegen,lees dan verder voor instructies. Een controleregel voor SOAP-webservice instellen Om een SOAP-service te testen, wordt doorgaans een methode van die webservice aangeroepen, door er invoerdata naar te posten in de vorm van een SOAP-envelop en dan te verifiëren dat de response correct is. Ga naar het configuratiescherm Nieuwe controleregel. (Weet u niet meer hoe u dit doet, ga dan naar het artikel Controleregels toevoegen in de Uptrends knowledge base.
-
Uptrends' cliëntcertificaat public key-informatieGebruik Uptrends' public keys met uw Multi-step API-controleregelrequests om te verzekeren dat requests afkomstig zijn van Uptrends."
-
Variabelen bij Multi-step monitoringHoe u variabelen gebruikt voor het opslaan van waarden uit uw API-responses voor gebruik in latere stappen.
-
Vergelijkingsoperatoren in Multi-step monitoringLeer welke vergelijkingsoperatoren beschikbaar zijn bij het configureren van Multi-Step API monitoring.
-
Vrije Kengetallen instellenIn dit artikel wordt beschreven hoe u de functie Vrije Kengetallen kunt gebruiken om data van API’s vast te leggen. Dit kan de API van een technische partner zijn die u voor uw bedrijf gebruikt of uw eigen API die u hebt gebouwd om uw eigen klanten of processen te ondersteunen. Het kan zelfs een aangepaste API zijn die u hebt gebouwd om uw interne bedrijfsstatistieken of platformstatistieken te verzamelen of berekenen.
-
Webservices monitorenU kent misschien al Uptrends' controleregeltypes voor het monitoren van websites en servers, maar Uptrends ondersteunt ook het monitoren van de uptime van webservices.