AntiBaitby FluenceSecurity

Dokumentacja dla deweloperów

Dokumentacja

Instrukcje i dokumentacja API: jak uruchamiać analizy AntiBait w aplikacji webowej i z własnego kodu.

Dokumentacja API

Odznaka statusu

Public

Prosty endpoint JSON do osadzania odznaki statusu na zewnętrznych stronach. Działa z shields.io i podobnymi usługami.

Endpoint API

GET
GET/api/status/badge

Żądanie

Uwierzytelnienie nie jest wymagane
Treść żądania nie jest potrzebna

Publiczny endpoint z włączonym CORS dla żądań cross-origin.

Odpowiedź

{
  "schemaVersion": 1,
  "label": "status",
  "message": "string",
  "color": "string",
  "status": "operational" 
    | "degraded" | "outage",
  "uptime": "string"
}

Przykładowe odpowiedzi

cURL

curl https://antibait.io/api/status/badge

Usługa działa

{
  "schemaVersion": 1,
  "label": "status",
  "message": "All Systems Operational",
  "color": "brightgreen",
  "status": "operational",
  "uptime": "99.9%"
}

Obniżona wydajność

{
  "schemaVersion": 1,
  "label": "status",
  "message": "Degraded Performance",
  "color": "yellow",
  "status": "degraded",
  "uptime": "94.5%"
}

Awaria usługi

{
  "schemaVersion": 1,
  "label": "status",
  "message": "Service Outage",
  "color": "red",
  "status": "outage",
  "uptime": null
}

Pola odpowiedzi

schemaVersionnumber

Wersja schematu odznaki (zawsze 1, zgodnie z shields.io)

labelstring

Tekst etykiety odznaki (zawsze "status")

messagestring

Komunikat statusu czytelny dla człowieka

colorstring

Kolor odznaki: "brightgreen" (działa), "yellow" (zakłócenia), "red" (awaria), "lightgrey" (nieznany)

statusstring

Status czytelny dla maszyn: "operational", "degraded", "outage" lub "unknown"

uptimestring

Odsetek udanych analiz z ostatniej godziny (np. "99.9%") albo null, jeśli żadnej nie było

Integracja z Shields.io

Endpoint zwraca dane w formacie JSON endpoint z shields.io, więc działa z ich dynamicznymi odznakami.

URL Shields.io

https://img.shields.io/endpoint?url=https://antibait.io/api/status/badge

Przykład Markdown

![API Status](https://img.shields.io/endpoint?url=https://antibait.io/api/status/badge)

Przykład HTML

<img src="https://img.shields.io/endpoint?url=https://antibait.io/api/status/badge" alt="API Status">

Jak ustalamy status

✓

Działa

Baza danych działa ORAZ odsetek udanych analiz ≥ 95%

!

Zakłócenia

Baza danych działa, ALE odsetek udanych analiz < 95%

✗

Awaria

Sprawdzanie stanu bazy danych nie powiodło się

?

Nieznany

Wystąpił błąd podczas sprawdzania statusu

Wskazówki

Buforowanie

Odpowiedzi są buforowane przez 60 sekund, z oknem stale-while-revalidate wynoszącym 120 sekund. Dzięki temu odznaki nie obciążają nadmiernie serwera, a wciąż są w miarę aktualne.

Wyświetlanie odznaki

Użyj tego endpointu, aby pokazywać bieżący status API w README, dokumentacji lub na stronie. Dzięki kolorom status widać na pierwszy rzut oka.

Obsługa CORS

Żądania cross-origin są dozwolone, więc możesz pobierać te dane bezpośrednio z JavaScriptu po stronie klienta i budować własne odznaki.

Jak liczymy dostępność

Dostępność liczymy na podstawie żądań analizy z ostatniej godziny, więc odzwierciedla bieżącą niezawodność API.

Potrzebujesz pomocy z integracją API? Zespół wsparcia odpowiada w ciągu 24 godzin w dni robocze.

KontaktZobacz FAQZarządzaj kluczami API