SDKs
شناخت کی تصدیق کا SDK، اور بغیر SDK کا راستہ۔
زیادہ تر انٹیگریشنز کو SDK کی بالکل ضرورت نہیں — کام ہوسٹڈ صفحہ کر دیتا ہے۔ ویب ویجٹ اس وقت کے لیے ہے جب آپ چاہیں کہ فلو آپ کے اپنے صفحے کے اندر رہے۔ نیٹو موبائل SDKs اگلے مرحلے میں ہیں۔
بغیر SDK کا راستہ
ہوسٹڈ صفحے کو کسی بھی پلیٹ فارم پر SDK کی ضرورت نہیں۔
POST /v1/sessions ایک verification_url لوٹاتا ہے۔ اسے درخواست گزار کو اسی طرح بھیجیں جیسے آپ کی پروڈکٹ پہلے سے لنکس بھیجتی ہے — ای میل، SMS، ایپ کے اندر ری ڈائریکٹ، یا اسکرین پر QR کوڈ — اور ShieldID ان کے اپنے فون پر کیپچر، لائیونیس چیلنج اور سیلفی سنبھال لیتا ہے۔
- ویب ایپ، نیٹو ایپ کے سسٹم براؤزر یا WebView، ای میل لنک، یا کیوسک QR کوڈ سے کام کرتا ہے — کچھ انسٹال کرنے کی ضرورت نہیں
- اہل پلانز پر وائٹ لیبل برانڈنگ، تاکہ یہ کسی تیسرے فریق کو حوالگی نہ لگے
- نتائج آپ تک return_url ری ڈائریکٹ اور دستخط شدہ ویب ہک کے ذریعے پہنچتے ہیں — کلائنٹ سائیڈ کال بیک جوڑنے کی ضرورت نہیں
ویب ویجٹ
فلو کو اپنے صفحے میں ایمبیڈ کریں۔
ایک چھوٹا اسکرپٹ جو ہوسٹڈ تصدیقی فلو کو آپ کے صفحے پر ایک iframe کے اندر دکھاتا ہے، بجائے اس کے کہ درخواست گزار کو صفحے سے باہر بھیجے۔
آج کیا کام کرتا ہے
- TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) ایک سیشن بناتا ہے اور اسے آپ کے منتخب کردہ عنصر میں ماؤنٹ کر دیتا ہے
- ہوسٹڈ صفحے جیسا ہی کیپچر فلو آپ کے اپنے لے آؤٹ کے اندر چلاتا ہے، آپ کے accentColor اور لوگو کے ساتھ
- آج سیشن بنانے اور فلو کو صفحے کے اندر دکھانے کے لیے کام کرتا ہے
تکمیل کے کال بیکس
جلد آ رہا ہےonComplete، onCancel، onStep اور iframe کی خودکار سائز تبدیلی ویجٹ کے انٹرفیس کا حصہ ہیں، لیکن فلو کے اندر ابھی کوئی چیز انہیں متحرک نہیں کرتی۔ ایسی منطق نہ بنائیں جو ان کے چلنے پر منحصر ہو — اس کے بجائے return URL اور webhook استعمال کریں، جو دونوں آج کام کرتے ہیں۔
براؤزر میں API کیز کے بارے میں ایک نوٹ
ویجٹ کی اپنی init() کال کے بارے میں دستاویزات میں لکھا ہے کہ وہ کلائنٹ سائیڈ JavaScript میں خام apiKey قبول کرتی ہے۔ ہم پروڈکشن میں اس کی سفارش نہیں کرتے: جو بھی سورس دیکھے گا اسے آپ کی کلید مل جائے گی۔ اس کے بجائے اپنے بیک اینڈ پر POST /v1/sessions کے ذریعے سیشن بنائیں، اور ویجٹ کو نتیجے میں ملنے والا verification_url دکھانے کے لیے دیں — یہ وہی سفارش ہے جو hosted فلو کے لیے ہے، بس لنک کی جگہ ایمبیڈ کیا گیا ہے۔
<div id="shieldid-verify"></div>
<!-- Exact script URL is published with your API keys; the path below is illustrative. -->
<script src="https://cdn.shieldid.ca/sdk/v1/widget.js"></script>
<script>
// Recommended: create the session on your backend first (see API reference),
// then pass its verification_url straight through — never a raw API key.
TLVerify.init({
containerId: "shieldid-verify",
verificationUrl: "{{ session.verification_url }}", // from your backend
theme: { accentColor: "#0B5CD8" },
});
</script>موبائل
نیٹو SDKs جلد آ رہے ہیں۔
آج iOS یا Android کا کوئی SDK موجود نہیں۔ جب تک وہ نہیں آتا، hosted ویریفیکیشن صفحہ اپنی ایپ کے سسٹم براؤزر یا WebView کے اندر کھولیں — یہ وہی فلو ہے جو ویب درخواست دہندہ کو ملتا ہے، اور یہ اب بھی کام کرتا ہے، ہر اس پلیٹ فارم پر جس پر آپ کی ایپ چلتی ہے۔
جلد آ رہا ہےنیٹو iOS اور Android SDKs
راستے کا انتخاب
تین راستے، ایمانداری سے موازنہ۔
جب تک ایمبیڈ کرنے کی کوئی خاص وجہ نہ ہو، hosted صفحے سے آغاز کریں۔
| صلاحیت | Hosted صفحہ | ویب ویجٹ | موبائل SDK |
|---|---|---|---|
| کوئی SDK نہیں، کلائنٹ سائیڈ کوڈ نہیں | جی ہاں | نہیں | جلد آ رہا ہے |
| آپ کے اپنے صفحے کے اندر رہتا ہے | لنک کے طور پر کھلتا ہے | ایمبیڈڈ iframe | جلد آ رہا ہے |
| آپ کے کوڈ میں تکمیل کے callbacks | ریٹرن URL + ویب ہُک | جلد آ رہا ہے | جلد آ رہا ہے |
| آپ کی برانڈنگ | اہل پلانز پر | اہل پلانز پر | جلد آ رہا ہے |
| آج کام کرتا ہے | جی ہاں | جی ہاں | نہیں |
سوالات
SDK اور ویجیٹ FAQ۔
بنانا شروع کریں
Hosted صفحہ شروع کرنے کا تیز ترین راستہ ہے۔
ایک API کال، ایک لنک، کسی SDK کی ضرورت نہیں۔ آج ہی sandbox کلید کے ساتھ آزما کر دیکھیں۔