Monitoring API

Monitory API automaticky ověřují, že jsou vaše API endpointy dostupné, výkonné a vracejí správná data. Díky tomu máte jistotu, že vaše aplikace a integrace fungují, jak mají.

Podobně jako u ostatních monitorů platí, že když monitor API odhalí problém, můžete incident vyřešit společně s týmem a volitelně aktualizovat svou stavovou stránku.

Hlavní funkce

• Testování API endpointů z různých lokalit po celém světě každých 30 sekund.
• Ověřování HTTP stavových kódů, těla JSON, hlaviček a dob odezvy.
• Vlastní hlavičky, parametry dotazu nebo JSON payloady.
• Okamžité upozornění, když je endpoint nedostupný, pomalý nebo vrací neočekávané výsledky.
• Napojení na Slack, e-mail, SMS, telefonáty, webhooky a další.

Přidání prvního monitoru API

Monitor vytvoříte ve svém projektu → Monitory → Přidat monitor.

Typ monitoru

Jako typ monitoru zvolte API.

Zadejte URL endpointu, který chcete monitorovat — například
https://api.yourservice.com/v1/users.

Konfigurace požadavku

Požadavek na API si můžete plně přizpůsobit:

• HTTP metoda: GET, POST, PUT, PATCH, DELETE, OPTIONS nebo HEAD
• Tělo: Pošlete s požadavkem JSON, form data, GraphQL nebo prostý text
• Ověření: Přidejte basic authentication, API klíč nebo autorizaci přes Bearer token
• Parametry dotazu: Připojte k URL požadavku dvojice klíč/hodnota
• Hlavičky: Přidejte vlastní hlavičky, které váš požadavek potřebuje

Monitor je úspěšný, když

Monitor API je úspěšný, když jsou splněné všechny zadané podmínky.
Nastavit můžete jednu nebo víc z těchto kontrol:

• Stavový kód: např. odpověď je 200 OK
• Doba odezvy: např. pod 1 sekundu
• Tělo obsahuje: např. "success": true
• Cesta v JSON: např. data.status se rovná "active"
• Hlavička obsahuje: např. Content-Type: application/json

Pokud některá z podmínek splněná není, monitor se označí jako nedostupný a rozešlou se upozornění podle vašeho nastavení upozornění.

Pokročilá nastavení

• Popisný název: Pojmenujte monitor výstižně, ať ho snadno poznáte.
• Spouštět kontroly každých: Rozhodněte, jak často se má endpoint testovat.
• Spouštět z: Vyberte testovací lokality (Spojené státy, Kanada, Evropa, Asie).
• Přidat na stavovou stránku: Zveřejněte dostupnost API a statistiky odezvy.
• Když monitor selže: Založte incident, upozorněte odběratele nebo publikujte na stavovou stránku.
• Když se monitor obnoví: Vyřešte incidenty a automaticky aktualizujte stavovou stránku.