Dokumentacja API

API antyfraudowe

Przeglądarkowy SDK do identyfikacji, podpisane webhooki do zdarzeń w czasie rzeczywistym oraz API zarządzania przestrzenią roboczą. Wszystko, czego potrzebujesz, by powstrzymać oszustwa na poziomie urządzenia.

Uzyskaj klucz API API Playground

Endpointy

SDK@tracio/sdk

Zidentyfikuj odwiedzającego w przeglądarce za pomocą klienckiego SDK. Zwraca stabilne ID odwiedzającego i werdykt bota bez odwołania do serwera. Klucz publiczny można bezpiecznie umieścić w kodzie po stronie klienta.

Żądanie

import { Tracio } from '@tracio/sdk'
const tracio = Tracio.init({ publicKey: '5ca175fc...' })
const result = await tracio.getResult()

Odpowiedź

{
  "visitorId": "X7fh2Hg9LkMn3pQr",
  "bot": {
    "detected": false,
    "confidence": 2,
    "reasons": []
  }
}

POST/webhook/tracio

TRACIO dostarcza podpisane zdarzenie do Twojego endpointu przy każdej identyfikacji. Zweryfikuj nagłówek X-Tracio-Signature, a następnie działaj na płaskim payloadzie JSON. To serwerowa powierzchnia zdarzeń — nie ma odczytu REST typu poll-by-requestId.

Żądanie

POST /webhook/tracio HTTP/1.1
Host: your-server.com
Content-Type: application/json
X-Tracio-Signature: t=1710432000,v1=5257a869e7ecebed...

Odpowiedź

{
  "requestId": "1710432000_abc123",
  "visitorId": "X7fh2Hg9LkMn3pQr",
  "bot": { "result": "human", "type": "", "score": 0.02 },
  "identification": { "confidence": 0.95, "visitType": "returning" },
  "network": { "vpn": false, "proxy": false, "tor": false, "datacenter": false },
  "decision": { "action": "allow", "riskScore": 4 }
}

POST/api/v1/workspaces/{workspaceId}/webhooks

Zarejestruj endpoint webhook przez API zarządzania przestrzenią roboczą. Uwierzytelniane sesją panelu (Clerk) JWT i sprawdzane względem Twojej roli w przestrzeni roboczej. Sekret podpisujący jest zwracany jednorazowo przy tworzeniu.

Żądanie

curl -X POST \
  https://app.tracio.ai/api/v1/workspaces/{workspaceId}/webhooks \
  -H "Authorization: Bearer <clerk-session-jwt>" \
  -H "Content-Type: application/json" \
  -d '{ "url": "https://your-server.com/webhook/tracio", "events": [] }'

Odpowiedź

{
  "ok": true,
  "data": {
    "id": "wh_abc123",
    "url": "https://your-server.com/webhook/tracio",
    "events": [],
    "signingSecret": "f3a9…<hex>",
    "status": "active",
    "createdAt": "2024-03-12T16:00:00Z"
  }
}

GET/api/v1/workspaces/{workspaceId}/visitors/{visitorId}

Sprawdź zapisaną historię odwiedzającego przez API zarządzania przestrzenią roboczą, uwierzytelniane sesją panelu (Clerk) JWT. Obsługuje żądania prawa dostępu w ramach RODO.

Żądanie

curl \
  https://app.tracio.ai/api/v1/workspaces/{workspaceId}/visitors/X7fh2Hg9LkMn3pQr \
  -H "Authorization: Bearer <clerk-session-jwt>"

Odpowiedź

{
  "ok": true,
  "data": {
    "visitorId": "X7fh2Hg9LkMn3pQr",
    "firstSeenAt": "2024-03-01T08:11:00Z",
    "lastSeenAt": "2024-03-16T14:22:01Z",
    "visits": 12
  }
}

Uwierzytelnianie

TRACIO używa trzech poświadczeń, po jednym na powierzchnię: klucza publicznego dla przeglądarkowego SDK, sesji panelu (Clerk) JWT dla API zarządzania przestrzenią roboczą oraz sekretu podpisującego HMAC do weryfikacji dostarczeń webhooków. Nie ma osobnego sekretu API.

# Client SDK — public key (safe to ship in the browser)
Tracio.init({ publicKey: '5ca175fc...' })
# Workspace management API — dashboard session (Clerk) JWT,
# additionally checked against your workspace role (RBAC)
Authorization: Bearer <clerk-session-jwt>
# Webhook verification — HMAC-SHA256 over "<t>.<rawBody>"
X-Tracio-Signature: t=<unix>,v1=<hmac_sha256_hex>

Limity szybkości

Limity obowiązują per przestrzeń robocza. Odpowiedzi API zarządzania zawierają nagłówki X-RateLimit-Limit, X-RateLimit-Remaining oraz Retry-After.

Plan	Identyfikacje	Zdarzenia webhook	API zarządzania	Sprawdzenia odwiedzających
Free	100/day	100/day	50/day	100/day
Pro	1,000/min	1,000/min	500/min	1,000/min
Enterprise	10,000/min	10,000/min	5,000/min	10,000/min

Kody błędów

Wszystkie błędy zwracają treść JSON z polami code, message i details.

400Bad RequestNieprawidłowa treść żądania lub brak wymaganych pól.

401UnauthorizedBrak lub nieprawidłowe poświadczenia — klucz publiczny (SDK), Clerk JWT (API zarządzania) lub podpis webhook.

403ForbiddenTwoja rola w przestrzeni roboczej (RBAC) nie ma uprawnień do tej operacji.

404Not FoundNie znaleziono ID odwiedzającego lub webhooka w Twojej przestrzeni roboczej.

429Rate LimitedZbyt wiele żądań. Sprawdź nagłówek Retry-After oraz limity swojego planu.

500Internal ErrorBłąd serwera. Ponów próbę z wykładniczym odczekiwaniem. Jeśli problem się utrzymuje, skontaktuj się ze wsparciem.

Format odpowiedzi błędu

{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded",
    "details": "1000 requests per minute limit reached for this workspace",
    "retryAfter": 12
  }
}

Zacznij budować

Uzyskaj klucz API i wykonaj pierwsze żądanie identyfikacji w mniej niż 5 minut.

Uzyskaj klucz API Pełna dokumentacja API