Dokumentacja dla deweloperów
Dokumentacja
Instrukcje i dokumentacja API: jak uruchamiać analizy AntiBait w aplikacji webowej i z własnego kodu.
Dokumentacja API
Sprawdzenie stanu
PublicProsty endpoint do sprawdzania stanu, przeznaczony dla usług monitoringu. Zwraca podstawowy stan systemu bez szczegółowych metryk.
Endpoint API
GET/api/status/healthŻądanie
Uwierzytelnienie nie jest wymagane
Treść żądania nie jest potrzebnaPubliczny endpoint, nie wymaga klucza API.
Odpowiedź
{
"status": "healthy" | "unhealthy",
"timestamp": "ISO-8601 string",
"checks": {
"database": "ok" | "failed",
"api": "ok"
},
"uptime": number | null
}Przykładowe żądanie
cURL
curl https://antibait.io/api/status/healthOdpowiedź healthy (200)
{
"status": "healthy",
"timestamp": "2025-11-07T12:34:56.789Z",
"checks": {
"database": "ok",
"api": "ok"
},
"uptime": 3600
}Odpowiedź unhealthy (503)
{
"status": "unhealthy",
"timestamp": "2025-11-07T12:34:56.789Z",
"checks": {
"database": "failed"
}
}Pola odpowiedzi
statusstringOgólny stan: "healthy" lub "unhealthy"
timestampstringCzas sprawdzenia stanu w formacie ISO-8601
checksobjectWyniki sprawdzenia stanu poszczególnych komponentów (baza danych, api)
uptimenumber | nullCzas działania procesu w sekundach (jeśli dostępny)
errorstring (optional)Komunikat błędu, gdy usługa jest niedostępna
Kody statusu HTTP
OK
Wszystkie systemy działają
Usługa niedostępna
Co najmniej jeden kluczowy komponent nie działa
Wskazówki
Buforowanie
Odpowiedzi są buforowane przez 10 sekund, z oknem stale-while-revalidate wynoszącym 30 sekund. Odciąża to serwer, a stan pozostaje niemal bieżący.
Integracja z monitoringiem
Sprawdza się z narzędziami do monitoringu, takimi jak UptimeRobot, Pingdom czy Datadog. Ustaw w swojej usłudze monitoringu regularne odpytywanie tego endpointu i alert przy odpowiedzi 503.
Lekkie sprawdzenie
Ten endpoint sprawdza tylko połączenie z bazą danych, więc odpowiada szybko. Szczegółowe metryki i status komponentów zwraca endpoint /api/status/metrics – użyj go, gdy potrzebujesz więcej danych.
Potrzebujesz pomocy z integracją API? Zespół wsparcia odpowiada w ciągu 24 godzin w dni robocze.