API-monitoring

Met API-monitors controleer je automatisch of je API-endpoints bereikbaar zijn, goed presteren en de juiste data teruggeven. Zo weet je zeker dat je applicaties en integraties werken zoals bedoeld.

Net als bij andere monitors kun je, wanneer een API-monitor een probleem vindt, samen met je team het incident oplossen en eventueel je statuspagina bijwerken.

Belangrijkste functies

• Test je API-endpoints elke 30 seconden vanaf verschillende locaties wereldwijd.
• Valideer HTTP-statuscodes, de JSON-body, headers en responstijden.
• Voeg eigen headers, query-parameters of JSON-payloads toe.
• Krijg meteen bericht als een endpoint down is, traag is of onverwachte resultaten teruggeeft.
• Koppel met Slack, e-mail, sms, telefoontjes, webhooks en meer.

Je eerste API-monitor toevoegen

Ga naar je project → Monitors → Monitor toevoegen om een monitor aan te maken.

Type monitor

Kies API als type monitor.

Vul de URL van het endpoint in dat je wilt monitoren — bijvoorbeeld
https://api.yourservice.com/v1/users.

Configuratie van het verzoek

Je kunt je API-verzoek volledig naar wens instellen:

• HTTP-methode: GET, POST, PUT, PATCH, DELETE, OPTIONS of HEAD
• Body: stuur JSON, formuliergegevens, GraphQL of platte tekst mee met je verzoek
• Auth: voeg basic authentication, een API-sleutel of Bearer-tokenautorisatie toe
• Query-parameters: hang sleutel/waarde-paren aan je verzoek-URL
• Headers: voeg de eigen headers toe die je API-verzoek nodig heeft

De monitor slaagt als

Een API-monitor slaagt wanneer aan alle opgegeven controles is voldaan.
Je kunt een of meer van de volgende controles instellen:

• Statuscode: bijvoorbeeld respons is 200 OK
• Responstijd: bijvoorbeeld onder 1 second
• Body bevat: bijvoorbeeld "success": true
• JSON-pad: bijvoorbeeld data.status is gelijk aan "active"
• Header bevat: bijvoorbeeld Content-Type: application/json

Als aan een van deze voorwaarden niet wordt voldaan, wordt de monitor als down gemarkeerd en gaan er meldingen uit volgens je meldingsinstellingen.

Geavanceerde instellingen

• Herkenbare naam: Geef je monitor een beschrijvende naam zodat je hem makkelijk herkent.
• Checks uitvoeren elke: Bepaal hoe vaak het endpoint getest wordt.
• Uitvoeren vanaf: Kies de testlocaties (Verenigde Staten, Canada, Europa, Azië).
• Toevoegen aan statuspagina: Toon de uptime en responscijfers van je API publiekelijk.
• Wanneer een monitor faalt: Start een incident, waarschuw abonnees of publiceer op je statuspagina.
• Wanneer een monitor herstelt: Los incidenten op en werk je statuspagina automatisch bij.