SDKs
ID सत्यापन SDK, और बिना SDK का रास्ता।
ज़्यादातर integrations को SDK की ज़रूरत ही नहीं होती — होस्टेड पेज सारा काम कर देता है। जब आप चाहें कि फ़्लो आपके अपने पेज के अंदर ही रहे, तब वेब विजेट है। नेटिव मोबाइल SDKs अगले चरण में आ रहे हैं।
बिना SDK का रास्ता
होस्टेड पेज को किसी भी प्लेटफ़ॉर्म पर SDK की ज़रूरत नहीं होती।
POST /v1/sessions एक verification_url लौटाता है। उसे आवेदक को उसी तरीके से भेजें जिससे आपका उत्पाद पहले से लिंक भेजता है — ईमेल, SMS, ऐप के भीतर redirect, स्क्रीन पर QR कोड — और ShieldID उनके अपने फ़ोन पर कैप्चर, liveness चैलेंज और सेल्फ़ी संभाल लेता है।
- वेब ऐप, नेटिव ऐप के सिस्टम ब्राउज़र या WebView, ईमेल लिंक या कियोस्क के QR कोड से काम करता है — कुछ इंस्टॉल करने की ज़रूरत नहीं
- योग्य प्लान पर white-label ब्रांडिंग, ताकि यह किसी तीसरे पक्ष को सौंपे जाने जैसा न लगे
- परिणाम return_url redirect और हस्ताक्षरित webhook के ज़रिए आप तक पहुँचते हैं — क्लाइंट-साइड callback जोड़ने की कोई ज़रूरत नहीं
वेब विजेट
फ़्लो को अपने ही पेज में एम्बेड करें।
एक छोटी स्क्रिप्ट जो होस्टेड सत्यापन फ़्लो को आपके पेज पर iframe के भीतर दिखाती है, आवेदक को पेज से बाहर भेजने के बजाय।
आज क्या काम करता है
- TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) एक session बनाता है और उसे आपके चुने हुए element में माउंट करता है
- आपके लेआउट के भीतर, आपके accentColor और लोगो के साथ, होस्टेड पेज जैसा ही कैप्चर फ़्लो चलाता है
- आज session बनाने और फ़्लो को इनलाइन दिखाने के लिए काम करता है
पूर्णता कॉलबैक
जल्द आ रहा हैonComplete, onCancel, onStep और iframe का स्वचालित रीसाइज़ widget के इंटरफ़ेस का हिस्सा हैं, लेकिन फ़्लो के अंदर अभी कुछ भी इन्हें ट्रिगर नहीं करता। ऐसा लॉजिक न बनाएँ जो इनके चलने पर निर्भर हो — इसके बजाय return URL और webhook का उपयोग करें, जो दोनों आज काम करते हैं।
ब्राउज़र में API keys के बारे में एक नोट
widget की अपनी init() कॉल क्लाइंट-साइड JavaScript में सीधे apiKey स्वीकार करने के लिए प्रलेखित है। हम प्रोडक्शन में इसकी सलाह नहीं देते: सोर्स देखने वाला कोई भी व्यक्ति आपकी key पा सकता है। इसके बजाय अपने बैकएंड पर POST /v1/sessions से सत्र बनाएँ, और widget को रेंडर करने के लिए उससे मिला verification_url दें — यह होस्टेड फ़्लो जैसी ही सिफ़ारिश है, बस लिंक की जगह एम्बेड किया हुआ।
<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 उपलब्ध नहीं है। जब तक यह नहीं आता, होस्टेड सत्यापन पेज को अपने ऐप के सिस्टम ब्राउज़र या WebView में खोलें — यह वही फ़्लो है जो वेब आवेदक को मिलता है, और यह अभी काम करता है, आपका ऐप जिस भी प्लैटफ़ॉर्म पर चले।
जल्द आ रहा हैनेटिव iOS और Android SDKs
रास्ता चुनना
अंदर आने के तीन तरीक़े, ईमानदार तुलना के साथ।
जब तक एम्बेड करने की कोई ख़ास वजह न हो, होस्टेड पेज से शुरू करें।
| क्षमता | होस्टेड पेज | वेब widget | मोबाइल SDK |
|---|---|---|---|
| कोई SDK नहीं, कोई क्लाइंट-साइड कोड नहीं | हाँ | नहीं | जल्द आ रहा है |
| आपके अपने पेज के अंदर रहता है | लिंक के रूप में खुलता है | एम्बेडेड iframe | जल्द आ रहा है |
| आपके कोड में पूर्णता कॉलबैक | रिटर्न URL + webhook | जल्द आ रहा है | जल्द आ रहा है |
| आपकी ब्रांडिंग | योग्य प्लान पर | योग्य प्लान पर | जल्द आ रहा है |
| आज काम करता है | हाँ | हाँ | नहीं |
प्रश्न
SDK और widget FAQ।
बनाना शुरू करें
होस्टेड पेज अंदर आने का सबसे तेज़ तरीक़ा है।
एक API कॉल, एक लिंक, किसी SDK की ज़रूरत नहीं। आज ही sandbox key के साथ आज़माएँ।