Přejít na obsah

Referenční příručka API

Antifraudové API

Prohlížečový SDK pro identifikaci, podepsané webhooky pro události v reálném čase a API pro správu workspace. Vše, co potřebujete k zastavení podvodů na úrovni zařízení.

Získat API klíčAPI Playground

Endpointy

SDK@tracio/sdk

Identifikujte návštěvníka v prohlížeči pomocí klientského SDK. Vrací stabilní ID návštěvníka a verdikt o botovi bez zpáteční komunikace se serverem. Veřejný klíč je bezpečné dodávat v kódu na straně klienta.

Požadavek

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

Odpověď

{
  "visitorId": "X7fh2Hg9LkMn3pQr",
  "bot": {
    "detected": false,
    "confidence": 2,
    "reasons": []
  }
}
POST/webhook/tracio

TRACIO doručí podepsanou událost na váš endpoint při každé identifikaci. Ověřte hlavičku X-Tracio-Signature a poté zpracujte plochý JSON payload. Toto je serverová plocha událostí — neexistuje žádné REST čtení typu poll-by-requestId.

Požadavek

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

Odpověď

{
  "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

Zaregistrujte webhookový endpoint prostřednictvím API pro správu workspace. Autentizace probíhá pomocí JWT vaší dashboardové relace (Clerk) a kontroluje se vůči vaší roli ve workspace. Podpisový tajný klíč je vrácen jednou při vytvoření.

Požadavek

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": [] }'

Odpověď

{
  "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}

Vyhledejte uloženou historii návštěvníka prostřednictvím API pro správu workspace, autentizovaného pomocí JWT vaší dashboardové relace (Clerk). Podporuje požadavky na přístup k datům podle GDPR.

Požadavek

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

Odpověď

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

Autentizace

TRACIO používá tři přihlašovací údaje, jeden pro každou plochu: veřejný klíč pro prohlížečový SDK, JWT vaší dashboardové relace (Clerk) pro API pro správu workspace a HMAC podpisový tajný klíč k ověření doručení webhooků. Neexistuje žádný samostatný tajný klíč 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>

Omezení počtu požadavků

Limity jsou na workspace. Odpovědi API pro správu obsahují hlavičky X-RateLimit-Limit, X-RateLimit-Remaining a Retry-After.

PlánIdentifikaceWebhookové událostiAPI pro správuVyhledávání návštěvníků
Free100/day100/day50/day100/day
Pro1,000/min1,000/min500/min1,000/min
Enterprise10,000/min10,000/min5,000/min10,000/min

Chybové kódy

Všechny chyby vracejí tělo JSON s poli code, message a details.

400Bad RequestChybně formátované tělo požadavku nebo chybějící povinná pole.
401UnauthorizedChybějící nebo neplatné přihlašovací údaje — veřejný klíč (SDK), Clerk JWT (API pro správu) nebo podpis webhooku.
403ForbiddenVaše role ve workspace (RBAC) nemá oprávnění k této operaci.
404Not FoundID návštěvníka nebo webhook nebyl ve vašem workspace nalezen.
429Rate LimitedPříliš mnoho požadavků. Zkontrolujte hlavičku Retry-After a limity svého plánu.
500Internal ErrorChyba serveru. Opakujte s exponenciálním odstupem. Pokud přetrvává, kontaktujte podporu.

Formát chybové odpovědi

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

Začněte stavět

Získejte svůj API klíč a proveďte první požadavek na identifikaci za méně než 5 minut.

Získat API klíčKompletní dokumentace API