Monitoring API

Monitory API pozwalają automatycznie weryfikować, czy Twoje endpointy są dostępne, działają wydajnie i zwracają poprawne dane. Dzięki temu masz pewność, że Twoje aplikacje i integracje działają zgodnie z założeniami.

Podobnie jak w przypadku innych monitorów, gdy monitor API wykryje problem, możesz wspólnie z zespołem rozwiązać incydent i opcjonalnie zaktualizować swoją stronę statusu.

Najważniejsze funkcje

• Testowanie endpointów API z różnych lokalizacji na świecie co 30 sekund.
• Weryfikacja kodów statusu HTTP, treści JSON, nagłówków i czasów odpowiedzi.
• Możliwość dodania własnych nagłówków, parametrów zapytania lub ładunków JSON.
• Natychmiastowe powiadomienia, gdy endpoint nie działa, działa wolno lub zwraca nieoczekiwane wyniki.
• Integracja ze Slackiem, e-mailem, SMS-ami, połączeniami telefonicznymi, webhookami i nie tylko.

Dodawanie pierwszego monitora API

Aby utworzyć monitor, przejdź do swojego projektu → Monitory → Dodaj monitor.

Typ monitora

Wybierz API jako typ monitora.

Wpisz adres URL endpointu, który chcesz monitorować — na przykład
https://api.yourservice.com/v1/users.

Konfiguracja żądania

Żądanie API możesz dostosować w pełni:

• Metoda HTTP: GET, POST, PUT, PATCH, DELETE, OPTIONS lub HEAD
• Treść: Wyślij wraz z żądaniem dane JSON, dane formularza, GraphQL lub zwykły tekst
• Uwierzytelnianie: Dodaj uwierzytelnianie basic, klucz API lub token Bearer
• Parametry zapytania: Dołącz pary klucz/wartość do adresu URL żądania
• Nagłówki: Dodaj własne nagłówki wymagane przez Twoje API

Monitor jest udany, jeśli

Monitor API kończy się powodzeniem, gdy spełnione są wszystkie wskazane asercje.
Możesz ustawić jedną lub więcej z poniższych asercji:

• Kod statusu: np. odpowiedź to 200 OK
• Czas odpowiedzi: np. poniżej 1 sekundy
• Treść zawiera: np. "success": true
• Ścieżka JSON: np. data.status równe "active"
• Nagłówek zawiera: np. Content-Type: application/json

Jeśli którykolwiek z tych warunków nie zostanie spełniony, monitor zostanie oznaczony jako niedziałający, a alerty zostaną wysłane zgodnie z Twoimi ustawieniami alertów.

Ustawienia zaawansowane

• Nazwa własna: Nadaj monitorowi opisową nazwę, aby łatwiej go rozpoznać.
• Uruchamiaj sprawdzenia co: Zdecyduj, jak często testować endpoint.
• Uruchamiaj z: Wybierz lokalizacje testowe (Stany Zjednoczone, Kanada, Europa, Azja).
• Dodaj do strony statusu: Publicznie prezentuj dostępność API i statystyki odpowiedzi.
• Gdy monitor wykryje awarię: Utwórz incydent, powiadom subskrybentów lub opublikuj informację na stronie statusu.
• Gdy monitor wykryje powrót do działania: Rozwiąż incydenty i automatycznie zaktualizuj stronę statusu.