API संदर्भ

एंटी-फ्रॉड API

पहचान के लिए एक ब्राउज़र SDK, रियल-टाइम इवेंट के लिए हस्ताक्षरित webhooks, और एक वर्कस्पेस प्रबंधन API। डिवाइस स्तर पर धोखाधड़ी रोकने के लिए आवश्यक सब कुछ।

API Key प्राप्त करें API Playground

एंडपॉइंट

SDK@tracio/sdk

क्लाइंट SDK के साथ ब्राउज़र में एक विज़िटर की पहचान करें। बिना किसी सर्वर राउंड-ट्रिप के एक स्थिर विज़िटर ID और बॉट निर्णय लौटाता है। पब्लिक की को क्लाइंट-साइड कोड में शिप करना सुरक्षित है।

अनुरोध

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 हर पहचान पर आपके एंडपॉइंट को एक हस्ताक्षरित इवेंट भेजता है। X-Tracio-Signature हेडर सत्यापित करें, फिर फ्लैट JSON पेलोड पर कार्रवाई करें। यह सर्वर-साइड इवेंट सतह है — कोई poll-by-requestId REST रीड नहीं है।

अनुरोध

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

वर्कस्पेस प्रबंधन API के माध्यम से एक webhook एंडपॉइंट रजिस्टर करें। आपके डैशबोर्ड सेशन (Clerk) JWT से प्रमाणित और आपकी वर्कस्पेस भूमिका के विरुद्ध जाँचा गया। साइनिंग सीक्रेट निर्माण के समय एक बार लौटाया जाता है।

अनुरोध

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 के माध्यम से किसी विज़िटर का संग्रहीत इतिहास देखें, जो आपके डैशबोर्ड सेशन (Clerk) JWT से प्रमाणित है। 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 के लिए एक पब्लिक की, वर्कस्पेस प्रबंधन API के लिए आपका डैशबोर्ड सेशन (Clerk) JWT, और webhook डिलीवरी सत्यापित करने के लिए एक HMAC साइनिंग सीक्रेट। कोई स्टैंडअलोन 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>

रेट लिमिट

सीमाएँ प्रति वर्कस्पेस हैं। प्रबंधन API प्रतिक्रियाओं में X-RateLimit-Limit, X-RateLimit-Remaining, और Retry-After हेडर शामिल होते हैं।

प्लान	पहचान	Webhook इवेंट	प्रबंधन API	विज़िटर लुकअप
फ्री	100/day	100/day	50/day	100/day
प्रो	1,000/min	1,000/min	500/min	1,000/min
एंटरप्राइज़	10,000/min	10,000/min	5,000/min	10,000/min

एरर कोड

सभी एरर code, message, और details फ़ील्ड वाला एक JSON बॉडी लौटाते हैं।

400Bad Requestगलत तरीके से बनी अनुरोध बॉडी या अनुपस्थित आवश्यक फ़ील्ड।

401Unauthorizedअनुपस्थित या अमान्य क्रेडेंशियल — पब्लिक की (SDK), Clerk JWT (प्रबंधन API), या webhook हस्ताक्षर।

403Forbiddenआपकी वर्कस्पेस भूमिका (RBAC) के पास इस ऑपरेशन के लिए अनुमति नहीं है।

404Not Foundआपके वर्कस्पेस में विज़िटर ID या webhook नहीं मिला।

429Rate Limitedबहुत अधिक अनुरोध। Retry-After हेडर और अपनी प्लान सीमाएँ जाँचें।

500Internal Errorसर्वर एरर। एक्सपोनेंशियल बैकऑफ़ के साथ पुनः प्रयास करें। यदि बना रहे, तो सहायता से संपर्क करें।

एरर प्रतिक्रिया प्रारूप

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

बनाना शुरू करें

अपनी API key प्राप्त करें और 5 मिनट से भी कम में अपना पहला पहचान अनुरोध करें।

API Key प्राप्त करें पूर्ण API दस्तावेज़