דלג לתוכן

API Reference

API למניעת הונאות

SDK לדפדפן לזיהוי, webhooks חתומים לאירועים בזמן אמת ו-API לניהול workspace. כל מה שאתם צריכים כדי לעצור הונאה ברמת המכשיר.

קבלו מפתח APIAPI Playground

Endpoints

SDK@tracio/sdk

זהו מבקר בדפדפן באמצעות ה-SDK בצד הלקוח. מחזיר מזהה מבקר יציב והכרעת בוט ללא סבב שרת. בטוח לשלוח את המפתח הציבורי בקוד בצד הלקוח.

בקשה

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

תגובה

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

TRACIO מספקת אירוע חתום ל-endpoint שלכם בכל זיהוי. אמתו את כותרת X-Tracio-Signature, ואז פעלו לפי מטען ה-JSON השטוח. זהו משטח האירועים בצד השרת — אין קריאת REST של poll-by-requestId.

בקשה

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

תגובה

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

רשמו endpoint של webhook דרך ה-API לניהול workspace. מאומת באמצעות ה-JWT של סשן לוח הבקרה (Clerk) ונבדק מול תפקידכם ב-workspace. סוד החתימה מוחזר פעם אחת בעת היצירה.

בקשה

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

תגובה

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

אתרו את ההיסטוריה המאוחסנת של מבקר דרך ה-API לניהול workspace, מאומת באמצעות ה-JWT של סשן לוח הבקרה (Clerk). תומך בבקשות זכות-גישה לפי GDPR.

בקשה

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

תגובה

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

אימות

TRACIO משתמשת בשלושה אישורים, אחד לכל משטח: מפתח ציבורי ל-SDK בדפדפן, ה-JWT של סשן לוח הבקרה (Clerk) ל-API לניהול workspace, וסוד חתימת HMAC לאימות מסירות webhook. אין סוד 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>

מגבלות קצב

המגבלות הן לכל workspace. תגובות ה-API לניהול כוללות את הכותרות X-RateLimit-Limit, X-RateLimit-Remaining ו-Retry-After.

תוכניתזיהוייםאירועי webhookAPI לניהולאיתורי מבקרים
חינם100/day100/day50/day100/day
Pro1,000/min1,000/min500/min1,000/min
Enterprise10,000/min10,000/min5,000/min10,000/min

קודי שגיאה

כל השגיאות מחזירות גוף JSON עם השדות code, message ו-details.

400Bad Requestגוף בקשה שגוי או שדות חובה חסרים.
401Unauthorizedאישורים חסרים או לא תקינים — מפתח ציבורי (SDK), Clerk JWT (API לניהול) או חתימת webhook.
403Forbiddenלתפקידכם ב-workspace (RBAC) אין הרשאה לפעולה זו.
404Not Foundמזהה מבקר או webhook לא נמצא ב-workspace שלכם.
429Rate Limitedיותר מדי בקשות. בדקו את כותרת Retry-After ואת מגבלות התוכנית שלכם.
500Internal Errorשגיאת שרת. נסו שוב עם exponential backoff. אם הבעיה נמשכת, פנו לתמיכה.

פורמט תגובת שגיאה

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

התחילו לבנות

קבלו את מפתח ה-API שלכם ובצעו את בקשת הזיהוי הראשונה שלכם בפחות מ-5 דקות.

קבלו מפתח APIתיעוד API מלא