پرش به محتوای اصلی
ShieldID

توسعه‌دهندگان

مستندات API تأیید هویت، ساخته‌شده برای استفادهٔ واقعی.

یک REST API، یک صفحهٔ میزبانی‌شده برای بخش‌هایی که نمی‌خواهید خودتان بسازید، و وب‌هوک‌های امضاشده تا لحظه‌ای که نتیجه آماده شد باخبر شوید. کلیدهای sandbox هرگز صورتحساب نمی‌شوند، پس سریع‌ترین راه برای شناخت ShieldID این است که آن را فراخوانی کنید.

شروع رایگان در sandboxراهنمای شروع سریع را بخوانید

نسخهٔ پنج‌دقیقه‌ای

چهار فراخوانی. یک مدل ذهنی.

هر چیز دیگر در این مستندات، جزئیاتی است که بر پایهٔ همین چرخه قرار می‌گیرد.

  1. یک نشست ایجاد کنید

    POST /v1/sessions را با یک return URL و یک webhook URL فراخوانی کنید. در پاسخ، یک session_id و یک verification_url دریافت می‌کنید.

  2. آن را به متقاضی بدهید

    verification_url را به‌صورت پیوند ارسال کنید، یا بگذارید متقاضی کد QR نمایش‌داده‌شده در صفحهٔ میزبانی‌شده را روی دسکتاپ اسکن کند. او کار را روی تلفن خودش به پایان می‌رساند.

  3. یک وب‌هوک امضاشده دریافت کنید

    وقتی نشست به VERIFIED یا FAILED برسد، ShieldID نتیجه را با POST به webhook URL شما ارسال می‌کند، به‌صورت امضاشده تا مطمئن شوید از طرف ما آمده است.

  4. نتیجه را بخوانید

    به وب‌هوک اعتماد کنید، یا خودتان GET /v1/sessions/{id}/result را فراخوانی کنید. در هر دو حالت، به‌جای یک امتیاز مبهم، نتیجهٔ هر بررسی را جداگانه دریافت می‌کنید.

امتحان کنید

نخستین جلسهٔ خود را ایجاد کنید.

همان درخواست در سه زبان. این همان فراخوانی است که مرحلهٔ یک مدل ذهنی توصیف می‌کند.

bash
# Create a verification session (sandbox keys are never billed)
curl -X POST https://api.shieldid.ca/v1/sessions \
  -H "X-Api-Key: vk_sand_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "return_url": "https://yourapp.example/verified",
    "webhook_url": "https://yourapp.example/hooks/shieldid"
  }'

# → { "session_id": "…", "verification_url": "https://…/v/…", "environment": "sandbox" }

کلیدهای sandbox (vk_sand_…) همین جریان را دقیقاً و رایگان اجرا می‌کنند. یک کلید vk_live_ جایگزین کنید و جز صورتحساب چیزی تغییر نمی‌کند.

راه خود را پیدا کنید

بقیهٔ مستندات توسعه‌دهندگان.

شش صفحه. همان‌هایی را بخوانید که لازم دارید.

مرجع API

هر نقطهٔ پایانی، هر فیلد و هر خطایی که می‌توانید برایش برنامه‌ریزی کنید.
باز کردن مرجع API

SDKs

ویجت وب، جریان میزبانی‌شده و آنچه در راه است.
باز کردن SDKs

Sandbox

حالت آزمایشی چگونه کار می‌کند و چگونه کلید بگیرید.
باز کردن Sandbox

Sandbox

پیش از امضای هر قراردادی، کل جریان را آزمایش کنید.

یک کلید sandbox (با پیشوند vk_sand_) همان API، همان صفحهٔ میزبانی‌شده و همان جریان webhook محیط عملیاتی را اجرا می‌کند. نشست‌ها در هر جا که نمایش داده شوند با environment: "sandbox" علامت‌گذاری می‌شوند و نشست‌های sandbox در هیچ طرحی صورتحساب نمی‌شوند.

راهنمای sandbox را بخوانید
  • نشست‌های واقعی بسازید، یک مدرک واقعی را با گوشی خودتان تأیید کنید و یک webhook امضاشدهٔ واقعی دریافت کنید
  • هیچ کاری که در sandbox انجام دهید روی صورتحساب شما اثر نمی‌گذارد
  • با تعویض پیشوند کلید به محیط عملیاتی بروید؛ ساختار درخواست تغییر نمی‌کند

ساخته‌شده در فضایی باز

چه چیزی کامل شده و چه چیزی هنوز نشده است.

ترجیح می‌دهیم خودمان به شما بگوییم، نه اینکه وسط یکپارچه‌سازی متوجه شوید.

callbackهای تکمیل در ویجت وب

به‌زودی

onComplete، onCancel و onStep هم‌اکنون در رابط ویجت وجود دارند، اما هنوز چیزی آن‌ها را فعال نمی‌کند. از نشانی بازگشت (return URL) و webhook استفاده کنید؛ هر دو اکنون کار می‌کنند.

اعمال محدودیت نرخ درخواست

به‌زودی

برای هر کلید API یک محدودیت نرخ متناسب با طرح شما ثبت شده است، اما هنوز روی درخواست‌ها اعمال نمی‌شود؛ بر این اساس برنامه‌ریزی کنید و انتظار نداشته باشید ShieldID درخواست‌های شما را محدود کند.

ثبت‌نام خودسرویس sandbox

به‌زودی

تا زمانی که ثبت‌نام خودسرویس در دست ساخت است، کلیدهای sandbox بنا بر درخواست صادر می‌شوند. درخواست بدهید تا سریع برایتان آماده کنیم.

پرسش‌ها

پاسخ‌های روشن برای توسعه‌دهندگان.

شروع کنید

در یک بعدازظهر فعال شوید.

با یک کلید sandbox شروع کنید، یک تأیید هویت را با گوشی خودتان اجرا کنید و webhook ارسالی را بخوانید. بدون نیاز به تماس فروش.

شروع رایگان در sandboxراهنمای شروع سریع را بخوانید

نشست‌های Sandbox هرگز صورت‌حساب نمی‌شوند.