Anti Phishing API

Ocena adresu URL w Twojej usłudze.

Przekaż publiczny adres do analizy i odbierz wynik ryzyka z kontekstem decyzji. API udostępnia detekcję APT w integracji między serwerami.

Pierwsze wywołanie

Użyj POST /v1/analyze z nagłówkiem Authorization: Bearer i obiektem JSON zawierającym pole url. Adres bazowy API oraz klucz pobierz z panelu organizacji. Poniższy przykład jest przeznaczony do uruchomienia na serwerze z ustawionymi zmiennymi środowiskowymi.

const response = await fetch(
  new URL('/v1/analyze', process.env.ANTIPHISHING_API_URL),
  {
    method: 'POST',
    headers: {
      Authorization: `Bearer ${process.env.ANTIPHISHING_API_KEY}`,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({ url: 'https://example.com' }),
    signal: AbortSignal.timeout(190_000),
  },
);

if (!response.ok) {
  // Błąd HTTP wymaga osobnej obsługi. Nie jest wynikiem SAFE.
  throw new Error(`Analiza niedostępna: HTTP ${response.status}`);
}
const analysis = await response.json();

Przekazuj publiczne adresy HTTP lub HTTPS. Nie umieszczaj w nich haseł, danych logowania ani tokenów dostępu. Nie osadzaj klucza API w kodzie przeglądarki, aplikacji mobilnej lub publicznym repozytorium. W środowisku produkcyjnym przechowuj go w menedżerze sekretów.

Wynik i kontekst decyzji

Ocena ryzyka

riskScore to liczba od 0 do 100. Pole verdict przyjmuje SAFE, SUSPICIOUS albo DANGEROUS. isPhishing ma wartość true dla DANGEROUS. SAFE opisuje wynik tej analizy i nie stanowi gwarancji bezpieczeństwa.

Uzasadnienie i adres docelowy

Odpowiedź zawiera reasons, finalUrl, redirectChain i sources. Pozwala powiązać ocenę z adresem końcowym i dostępnym kontekstem analizy. Pełny kontrakt pól znajduje się w OpenAPI.

Identyfikowalność

requestId i nagłówek X-Request-ID pomagają skorelować zdarzenie ze zgłoszeniem technicznym. analyzedAt, engineVersion i threatDatabaseVersion opisują czas oraz wersje użyte do oceny.

Limity organizacji

Zapytania podlegają limitom organizacji. Aktualny zakres sprawdzisz w panelu i warunkach usługi. Rozróżniaj wykorzystanie limitu od rozliczenia ukończonej analizy.

Błędy są częścią kontraktu integracji

Limit czasu usługi wynosi 180 sekund; zalecany limit klienta to 190 sekund. Przekroczenie czasu lub błąd usługi nie oznacza bezpiecznego adresu. W swoim produkcie przewidź osobny stan, w którym analiza nie została ukończona.

Dla 400, 401, 403 i 413 popraw żądanie lub konfigurację przed ponowieniem. Przy 429 respektuj nagłówek Retry-After. Dla przejściowych błędów 5xx stosuj ograniczone ponowienia zgodnie z dokumentacją, z opóźnieniem i losowym rozproszeniem żądań.

Kolejny krok

Zaplanuj integrację z APT.

Opisz miejsce analizy w swoim produkcie, oczekiwaną skalę i sposób obsługi wyniku. Uzgodnimy zakres testów przed wdrożeniem.