انتقل إلى المحتوى الرئيسي
ShieldID

المطورون

توثيق واجهة API للتحقق من الهوية، مصمَّم ليُستخدم فعلًا.

واجهة REST API واحدة، وصفحة مستضافة للأجزاء التي لا تريد بناءها، وwebhooks موقّعة لتعرف لحظة وصول النتيجة. مفاتيح sandbox لا تُحتسب عليها رسوم أبدًا، لذا فأسرع طريقة لفهم ShieldID هي استدعاؤه.

ابدأ مجاناً في بيئة sandboxاقرأ دليل البدء السريع

نسخة الدقائق الخمس

أربعة استدعاءات. نموذج ذهني واحد.

كل ما تبقى في هذا التوثيق تفاصيل مبنية على هذه الحلقة.

  1. أنشئ جلسة

    أرسل POST /v1/sessions مع عنوان URL للعودة وعنوان URL للـ webhook. ستحصل على session_id وverification_url.

  2. سلّمه إلى المتقدم

    أرسل verification_url كرابط، أو دَع المتقدم يمسح رمز QR الذي تعرضه الصفحة المستضافة على سطح المكتب. ثم يُكمل العملية على هاتفه.

  3. استلم webhook موقّعًا

    عندما تصل الجلسة إلى VERIFIED أو FAILED، يرسل ShieldID النتيجة بطلب POST إلى عنوان webhook الخاص بك، موقّعةً لتتأكد أنها صادرة عنا.

  4. اقرأ النتيجة

    ثق بالـ webhook، أو استدعِ 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 يصل إلى أي فاتورة
  • انتقل إلى الإنتاج بتبديل بادئة المفتاح؛ فشكل الطلب لا يتغير

نبني بشفافية

ما اكتمل منه، وما لم يكتمل بعد.

نفضّل أن نخبرك بذلك بدلًا من أن تكتشفه أثناء التكامل.

دوال الاستدعاء عند اكتمال أداة الويب

قريبًا

الدوال onComplete وonCancel وonStep موجودة في واجهة الأداة اليوم، لكن لا شيء يستدعيها بعد. استخدم عنوان URL للعودة وwebhook — فكلاهما يعمل الآن.

فرض حدود المعدل

قريبًا

لكل مفتاح API حد معدل مسجَّل وفق خطتك، لكنه لا يُفرض على الطلبات بعد — فخطّط وفق ذلك ولا تعتمد على ShieldID في تقييد الطلبات.

التسجيل الذاتي في sandbox

قريبًا

تُصدَر مفاتيح sandbox عند الطلب إلى أن يكتمل بناء التسجيل الذاتي. اطلب مفتاحًا وسنسلّمه لك بسرعة.

أسئلة

إجابات مباشرة للمطورين.

ابدأ الآن

انطلق فعليًا في ظهيرة واحدة.

ابدأ بمفتاح sandbox، ونفّذ عملية تحقق على هاتفك، واقرأ webhook الذي يصلك. دون الحاجة إلى مكالمة مبيعات.

ابدأ مجاناً في بيئة sandboxاقرأ دليل البدء السريع

لا تُحتسب رسوم على جلسات sandbox أبدًا.