SDKs
SDK تأیید هویت، و مسیر بدون SDK.
بیشتر یکپارچه‌سازی‌ها اصلاً به SDK نیاز ندارند؛ صفحهٔ میزبانیشده کار را انجام می‌دهد. ویجت وب برای زمانی است که می‌خواهید جریان کار درون صفحهٔ خودتان بماند. SDKهای بومی موبایل مرحلهٔ بعدی هستند.
مسیر بدون SDK
صفحهٔ میزبانیشده در هر پلتفرمی به SDK نیاز ندارد.
POST /v1/sessions یک verification_url برمی‌گرداند. آن را به هر روشی که محصول شما معمولاً پیوند می‌فرستد برای متقاضی ارسال کنید، مانند ایمیل، SMS، تغییر مسیر درون برنامه یا یک کد QR روی صفحه، و ShieldID ثبت مدرک، چالش زنده‌بودن و سلفی را روی تلفن همراه خود متقاضی انجام می‌دهد.
- از یک برنامهٔ وب، مرورگر سیستمی یا WebView یک برنامهٔ بومی، یک پیوند ایمیلی یا یک کد QR کیوسک کار میکند؛ چیزی برای نصب وجود ندارد
- برندینگ white-label در طرح‌های واجد شرایط، تا مانند واگذاری کار به شخص ثالث به نظر نرسد
- نتایج از طریق تغییر مسیر return_url و webhook امضاشده به شما می‌رسند؛ نیازی به اتصال callback سمت کلاینت نیست
ویجت وب
جریان کار را در صفحهٔ خودتان جاسازی کنید.
یک اسکریپت کوچک که جریان تأیید هویت میزبانیشده را بهجای دورکردن متقاضی از صفحه، درون یک iframe در صفحهٔ شما نمایش می‌دهد.
آنچه امروز کار میکند
- TLVerify.init({ apiKey, containerId, returnUrl, cancelUrl, webhookUrl, locale, theme }) یک نشست ایجاد میکند و آن را در عنصری که انتخاب می‌کنید نصب میکند
- همان جریان ثبت مدرک صفحهٔ میزبانیشده را درون طرح‌بندی شما، با accentColor و لوگوی شما اجرا میکند
- هماکنون برای ایجاد نشست و نمایش درون‌صفحه‌ای جریان کار قابل استفاده است
فراخوان‌های تکمیل
به‌زودیonComplete، onCancel، onStep و تغییر خودکار اندازهٔ iframe بخشی از رابط ویجت هستند، اما فعلاً هیچ بخشی از جریان آن‌ها را فعال نمیکند. منطقی که به اجرا شدن آن‌ها وابسته باشد پیاده‌سازی نکنید؛ بهجای آن از return URL و وبهوک استفاده کنید که هر دو هماکنون کار میکنند.
نکته‌ای دربارهٔ کلیدهای 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
انتخاب مسیر
سه راه ورود، با مقایسه‌ای صادقانه.
اگر دلیل مشخصی برای تعبیه ندارید، با صفحهٔ میزبانیشده شروع کنید.
| قابلیت | صفحهٔ میزبانیشده | ویجت وب | SDK موبایل |
|---|---|---|---|
| بدون SDK و بدون کد سمت کلاینت | بله | خیر | به‌زودی |
| درون صفحهٔ خودتان می‌ماند | به‌صورت پیوند باز می‌شود | iframe تعبیه‌شده | به‌زودی |
| کالبکهای تکمیل در کد شما | return URL + وبهوک | به‌زودی | به‌زودی |
| برند شما | در طرح‌های واجد شرایط | در طرح‌های واجد شرایط | به‌زودی |
| هماکنون در دسترس | بله | بله | خیر |
پرسش‌ها
پرسش‌های متداول SDK و ویجت.
شروع ساخت
صفحهٔ میزبانیشده سریع‌ترین راه ورود است.
یک فراخوانی API، یک پیوند، بدون نیاز به SDK. همین امروز با یک کلید sandbox امتحان کنید.