Een API kan snel antwoorden met het verkeerde: een foutobject met status 200, een lege lijst of een loginpagina. Een Website or API-monitor met responschecks vangt die gevallen op.
De monitor aanmaken
Open Monitors, kies New monitor en selecteer Website or API.Vul de URL van het endpoint in en kies onder Check every hoe vaak er gecontroleerd wordt.Kies in de kaart Request and response voor Keyword, headers and more.
Het request
Method: GET, HEAD, POST, PUT, PATCH, DELETE of OPTIONS.Request headers: één per regel als Name: value, zoals een API-sleutel of Accept: application/json.Request body, bijvoorbeeld JSON voor een POST.Follow redirects, Verify TLS certificate en Timeout (s).
Het antwoord
Expected status codes: codes of bereiken, zoals 200-299, 301. Elke andere status telt als down.Keyword: tekst die het antwoord wel of juist niet mag bevatten. Hoofdlettergevoelig.Response checks: JSON-velden en headers, zoals $.status is gelijk aan ok. Maximaal 10, en ze moeten allemaal kloppen.
Gebruik Test request om het antwoord te zien voordat je opslaat.
Trage antwoorden en timing
Stel Alert when slower than (ms) in, bijvoorbeeld 2000. Zijn drie checks op rij trager dan dat, dan wordt de monitor slow en krijgen je kanalen een traagheidsmelding; trage tijd telt niet als downtime. De responstijd van elke check is opgesplitst in DNS, connect, TLS, server en download, zodat je ziet waar de tijd heen gaat. Zie meldingen bij trage responstijden.
API’s met meerdere stappen
Hangt de ene call af van de andere, zoals inloggen om een token te krijgen, gebruik dan een flow met meerdere stappen.
Gebruik waar het kan een speciaal health-endpoint; zie een health check-endpoint bouwen en de checklist voor API-monitoring. Meer over API-monitoring.