API może odpowiedzieć szybko, ale nie tym, czym trzeba: obiektem błędu ze statusem 200, pustą listą albo stroną logowania. Monitor Website or API ze sprawdzaniem odpowiedzi wyłapuje takie przypadki.
Utwórz monitor
Otwórz Monitors, wybierz New monitor i wskaż Website or API.Wpisz URL endpointu i w polu Check every wybierz, jak często go sprawdzać.Na karcie Request and response wybierz Keyword, headers and more.
Żądanie
Method: GET, HEAD, POST, PUT, PATCH, DELETE lub OPTIONS.Request headers: jeden w wierszu, w formacie Name: value, np. klucz API lub Accept: application/json.Request body, np. JSON dla żądania POST.Follow redirects, Verify TLS certificate i Timeout (s).
Odpowiedź
Expected status codes: kody lub zakresy, np. 200-299, 301. Każdy inny status oznacza awarię.Keyword: tekst, który odpowiedź musi albo nie może zawierać. Wielkość liter ma znaczenie.Response checks: pola JSON i nagłówki, np. $.status równe ok. Maksymalnie 10 i wszystkie muszą być spełnione.
Użyj Test request, aby zobaczyć odpowiedź przed zapisaniem.
Wolne odpowiedzi i pomiar czasu
Ustaw Alert when slower than (ms), np. 2000. Gdy trzy sprawdzenia z rzędu będą wolniejsze, monitor przejdzie w stan spowolnienia, a Twoje kanały dostaną alert; czas spowolnienia nie liczy się jako niedostępność. Czas odpowiedzi każdego sprawdzenia jest rozbity na DNS, połączenie, TLS, serwer i pobieranie, więc widzisz, gdzie ucieka czas. Zobacz alerty o wolnych odpowiedziach.
API z kilkoma krokami
Gdy jedno wywołanie zależy od drugiego, np. logowanie w celu uzyskania tokenu, użyj zamiast tego wieloetapowego flow.
W miarę możliwości korzystaj z dedykowanego endpointu health check; zobacz, jak zbudować endpoint health check, oraz checklistę monitorowania API. Więcej o monitorowaniu API.