यह गाइड आपको अपने एप्लिकेशन में TRACIO को इंटीग्रेट करने की प्रक्रिया समझाती है। आप क्लाइंट SDK इंस्टॉल करेंगे, उसे अपनी पब्लिक की के साथ इनिशियलाइज़ करेंगे, और अपना पहला विज़िटर आइडेंटिफिकेशन परिणाम पढ़ेंगे।
अपने पसंदीदा पैकेज मैनेजर का उपयोग करके TRACIO SDK इंस्टॉल करें:
npm install @tracio/sdkया pnpm के साथ:
pnpm add @tracio/sdkया yarn के साथ:
yarn add @tracio/sdkयदि आप बंडलर का उपयोग नहीं करते, तो एज स्क्रिप्ट टैग को अपने पेज में डालें। यह k क्वेरी पैरामीटर में मौजूद पब्लिक की के साथ स्वतः इनिशियलाइज़ हो जाता है:
<script src="https://edge.tracio.ai/s.js?k=PUBLIC_KEY" async></script>Tracio को इम्पोर्ट करें और अपनी पब्लिक की के साथ Tracio.init() को कॉल करें। यह तुरंत एक TracioInstance लौटाता है — अंतर्निहित एजेंट बैकग्राउंड में लोड होता है।
import { Tracio } from "@tracio/sdk"
const tracio = Tracio.init({ publicKey: "5ca175fc...",})आपकी पब्लिक की को क्लाइंट-साइड कोड में भेजना सुरक्षित है। आप इसे अपने डैशबोर्ड में API Keys के अंतर्गत पा सकते हैं।
Tracio.init() एक TracioConfig ऑब्जेक्ट स्वीकार करता है:
| विकल्प | टाइप | डिफ़ॉल्ट | विवरण |
|---|---|---|---|
publicKey | string | आवश्यक | आपकी पब्लिक की। इसे अपने डैशबोर्ड से कॉपी करें। |
region | "us" | "eu" | कोई नहीं | वैकल्पिक डेटा रीजन। सेट न होने पर, SDK सामान्य https://edge.tracio.ai एंडपॉइंट का उपयोग करता है (कोई अंतर्निहित US डेटा रेज़िडेंसी नहीं)। us या eu को पिन करने के लिए इसे स्पष्ट रूप से सेट करें। |
endpoint | string | ऑटो | कस्टम API एंडपॉइंट (फर्स्ट-पार्टी-प्रॉक्सीड एंडपॉइंट के लिए)। |
scriptUrl | string | ऑटो | एजेंट स्क्रिप्ट के लिए कस्टम URL (फर्स्ट-पार्टी-प्रॉक्सीड एंडपॉइंट के लिए)। |
linkedId | string | कोई नहीं | पहचानकर्ता जो इस विज़िटर को आपके सिस्टम की किसी एंटिटी से जोड़ता है। |
tag | string | कोई नहीं | बाद में फ़िल्टरिंग के लिए अनुरोध से संलग्न किया गया फ्री-फॉर्म लेबल। |
debug | boolean | false | कंसोल में विस्तृत डायग्नोस्टिक्स लॉग करता है। |
timeoutMs | number | 15000 | टाइमआउट से पहले परिणाम की प्रतीक्षा कितनी देर तक की जाए। |
एक स्थिर विज़िटर पहचानकर्ता प्राप्त करने के लिए tracio.getVisitorId() को कॉल करें। यह एक एसिंक्रोनस ऑपरेशन है।
const visitorId = await tracio.getVisitorId()
console.log(visitorId) // "X7fh2Hg9LkMn3pQr"बॉट डिटेक्शन सहित पूरा आइडेंटिफिकेशन परिणाम प्राप्त करने के लिए tracio.getResult() को कॉल करें।
const result = await tracio.getResult()
console.log(result.visitorId) // "X7fh2Hg9LkMn3pQr"
if (result.bot.detected) { console.warn("bot, confidence:", result.bot.confidence)}परिणाम का आकार इस प्रकार होता है:
{ visitorId: "X7fh2Hg9LkMn3pQr", bot: { detected: false, confidence: 2, // 0-100 reasons: [], },}एजेंट के तैयार होने पर या कुछ विफल होने पर प्रतिक्रिया देने के लिए लाइफ़साइकिल कॉलबैक का उपयोग करें, और इंस्टेंस को हटाने के लिए destroy() का उपयोग करें:
const tracio = Tracio.init({ publicKey: "5ca175fc..." })
tracio.onReady((result) => { console.log("ready:", result.visitorId)})
tracio.onError((error) => { console.error("tracio error:", error.code, error.message)})
// later, when you no longer need ittracio.destroy()त्रुटि कोड्स और रीट्राई हेल्पर्स की पूरी सूची के लिए त्रुटि प्रबंधन देखें।
import { Tracio } from "@tracio/sdk"
const tracio = Tracio.init({ publicKey: "5ca175fc..." })
async function handleLogin(email: string, password: string) { const visitorId = await tracio.getVisitorId()
const response = await fetch("/api/login", { method: "POST", body: JSON.stringify({ email, password, visitorId }), })
return response.json()}import { Tracio } from "@tracio/sdk"
const tracio = Tracio.init({ publicKey: "5ca175fc...", tag: "payment",})
async function processPayment(paymentData: PaymentData) { const result = await tracio.getResult()
if (result.bot.detected) { throw new Error("Automated client detected") }
const response = await fetch("/api/payment", { method: "POST", body: JSON.stringify({ ...paymentData, visitorId: result.visitorId }), })
return response.json()}