SDKs
SDK للتحقق من الهوية، ومسار بلا SDK.
لا تحتاج معظم التكاملات إلى SDK إطلاقاً، فالصفحة المستضافة تؤدي العمل. وتتوفر أداة الويب عندما تريد أن يبقى المسار داخل صفحتك. أما SDKs للأجهزة المحمولة الأصلية فهي الخطوة التالية.
مسار بلا SDK
لا تحتاج الصفحة المستضافة إلى SDK، على أي منصة.
يعيد POST /v1/sessions الرابط verification_url. أرسله إلى المتقدّم بالطريقة التي يرسل بها منتجك الروابط أصلاً، سواء بالبريد الإلكتروني أو الرسائل النصية أو إعادة توجيه داخل التطبيق أو رمز QR على شاشة، وستتولى ShieldID التصوير وتحدّي الحيوية والصورة الذاتية على هاتفه.
- تعمل من تطبيق ويب، أو من متصفح النظام أو WebView في تطبيق أصلي، أو من رابط في بريد إلكتروني، أو من رمز QR في كشك، دون أي شيء يلزم تثبيته
- علامة تجارية بيضاء في الخطط المؤهلة، حتى لا يبدو الأمر كأنه تحويل إلى طرف ثالث
- تصلك النتائج عبر إعادة التوجيه إلى return_url وعبر الـ webhook الموقّع، دون الحاجة إلى ربط دوال رد نداء من جهة العميل
أداة الويب
ضمّن المسار في صفحتك.
سكربت صغير يعرض مسار التحقق المستضاف داخل iframe في صفحتك، بدلاً من نقل المتقدّم بعيداً عنها.
ما يعمل اليوم
- تنشئ TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) جلسة وتعرضها داخل عنصر تختاره
- تشغّل مسار التصوير نفسه الموجود في الصفحة المستضافة، داخل تخطيط صفحتك، مع accentColor والشعار الخاصين بك
- تعمل اليوم لإنشاء جلسة وعرض المسار داخل الصفحة
دوال الاستدعاء عند الاكتمال
قريبًاإن onComplete وonCancel وonStep والتحجيم التلقائي لإطار iframe جزء من واجهة الأداة (widget)، لكن لا شيء داخل مسار التحقق يُشغّلها حتى الآن. لا تبنِ منطقًا برمجيًا يعتمد على تنفيذها، بل استخدم عنوان URL للعودة والـ webhook، فكلاهما يعمل اليوم.
ملاحظة حول مفاتيح API في المتصفح
يوضّح التوثيق أن استدعاء init() الخاص بالأداة يقبل apiKey خامًا في JavaScript من جهة العميل. لا نوصي بذلك في بيئة الإنتاج: فكل من يعرض مصدر الصفحة سيحصل على مفتاحك. أنشئ الجلسة على الخادم الخلفي لديك عبر POST /v1/sessions، ثم مرّر إلى الأداة 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>الجوال
حزم SDK الأصلية قادمة قريبًا.
لا توجد حزمة SDK لنظام iOS أو Android اليوم. وإلى أن تتوفر، افتح صفحة التحقق المستضافة داخل متصفح النظام في تطبيقك أو داخل WebView، فهو المسار نفسه الذي يحصل عليه المتقدم عبر الويب، ويعمل الآن على أي منصة يعمل عليها تطبيقك.
قريبًاحزم SDK الأصلية لنظامي iOS وAndroid
اختيار المسار
ثلاث طرق للبدء، مقارنة بصراحة.
ابدأ بالصفحة المستضافة ما لم يكن لديك سبب محدد للتضمين.
| الإمكانية | الصفحة المستضافة | أداة الويب (Web widget) | SDK للجوال |
|---|---|---|---|
| بدون SDK وبدون شيفرة من جهة العميل | نعم | لا | قريبًا |
| تبقى داخل صفحتك | تُفتح كرابط | إطار iframe مضمّن | قريبًا |
| دوال رد نداء الإكمال في شيفرتك | عنوان URL للعودة + webhook | قريبًا | قريبًا |
| علامتك التجارية | ضمن الخطط المؤهلة | ضمن الخطط المؤهلة | قريبًا |
| يعمل اليوم | نعم | نعم | لا |
أسئلة
الأسئلة الشائعة حول SDK والأداة (widget).
ابدأ البناء
الصفحة المستضافة هي أسرع طريقة للبدء.
استدعاء API واحد ورابط واحد دون الحاجة إلى SDK. جرّبها اليوم بمفتاح sandbox.