نظرة عامة على مرجع API

كل ما تحتاجه للانتقال من الصفر إلى أول humanToken.

Markdown

يحتوي Human Token على ثلاث نقاط نهاية. توضح هذه الصفحة كيف تتكامل معاً حتى تتمكن من بدء الدمج على الفور.

عنوان URL الأساسي

البيئة	عنوان URL الأساسي
الإنتاج	https://humantoken.unico.app

تتطلب جميع الطلبات ترويسة x-unico-accesskey. راجع المصادقة لإنشاء مفتاحك.

---

تدفق البدء السريع

---

الخطوة 1 — المصادقة

قم بإنشاء x-unico-accesskey الخاص بك في Human Dashboard أو عبر Authentication API. يستخدم كل طلب أدناه هذا المفتاح.

x-unico-accesskey: uip_ak.prod.a1b2c3d4.e5f6g7h8.i9j0k1l2

---

الخطوة 2 — إنشاء عملية

اتصل بـ Create Process لبدء التحقق. اختر أحد النموذجين:

النموذج	التدفقات	كيف يعمل
API Only	api+humantoken, api+liveness+humantoken, api+liveness+humantoken+revalidation	يرسل الخادم الخلفي صورة السيلفي كـ imageBase64. يعود humanToken في نفس الاستجابة.
Human Token Journey	humantoken, humantoken+revalidation	يكمل المستخدم الالتقاط على منصة Unico. تحصل على token و link لعرض الرحلة، ثم تجلب النتيجة باستخدام Get Process.

مثال API Only:

curl -X POST https://humantoken.unico.app/client/v1/process \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "api+humantoken",
    "imageBase64": "<base64-encoded-selfie>",
    "companyBranchId": "<your-branch-id>"
  }'

مثال Human Token Journey:

curl -X POST https://humantoken.unico.app/client/v1/process \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "humantoken",
    "callbackUri": "https://yourapp.com/callback",
    "companyBranchId": "<your-branch-id>"
  }'

راجع Create Process لجميع التدفقات والمعلمات وتفاصيل الاستجابة.

---

الخطوة 3 — عرض الرحلة للمستخدم (تدفقات Journey فقط)

بالنسبة لتدفقات humantoken و humantoken+revalidation، تتضمن استجابة Create Process:

• token — يقوم بتهيئة Web SDK أو الدمج الأصلي
• link — عنوان URL لإعادة توجيه المستخدم إليه

اختر الدمج المناسب لمنصتك:

المنصة	النهج
Web — SDK	قم بتضمين الرحلة مباشرة باستخدام idpay-b2b-sdk → Web Integration
Web — Redirect	أعد توجيه المستخدم إلى link → Web Integration
Android	Custom Tabs → Android
iOS	ASWebAuthenticationSession → iOS
Ionic	Capacitor plugin → Ionic
React Native	Native module → React Native
Flutter	Platform Channels → Flutter

عندما تنتهي الرحلة، يعود المستخدم إلى callbackUri الخاص بك. انتقل إلى الخطوة 4.

تدفقات API Only

تخطَّ هذه الخطوة — النتيجة موجودة بالفعل في استجابة Create Process.

---

الخطوة 4 — استرداد النتيجة (تدفقات Journey فقط)

اتصل بـ Get Process باستخدام معرف العملية id لجلب النتيجة:

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

تتضمن الاستجابة data.humanToken.value (التدفقات القياسية) أو data.humanTokenMatch (تدفقات إعادة التحقق). راجع Get Process للاطلاع على مخطط الاستجابة الكامل وقيم الحالة.

---

الخطوة 5 — استخدام humanToken

humanToken هو معرّف ثابت ومبهم (حتى 100 حرف). يُحلّ الشخص نفسه دائماً إلى نفس القيمة.

const { humanToken } = process.data;

if (!humanToken?.value) {
  // Inconclusive — retry or reject per your business rules
  return;
}

const existing = await db.persons.findByHumanToken(humanToken.value);

if (existing) {
  // Same person seen before — returning user or duplicate
} else {
  // First time — create a new record
  await db.persons.create({ humanToken: humanToken.value });
}

تحذير

تحقق دائماً من أن data.humanToken.value ليست فارغة قبل تخزينها أو مطابقتها.

---

الخطوة 6 — استرداد صورة السيلفي (اختياري)

اتصل بـ Get Selfie لتنزيل الصورة الملتقطة. تكون صورة السيلفي متاحة لمدة 24 ساعة بعد انتهاء العملية — بعد ذلك يتم حذفها نهائياً.

curl https://humantoken.unico.app/client/v1/process/$PROCESS_ID/selfie \
  -H "x-unico-accesskey: $UNICO_ACCESS_KEY"

راجع Get Selfie لتفاصيل الاستجابة ورموز الخطأ.

---

نقاط النهاية في لمحة

الطريقة	نقطة النهاية	الوصف
POST	/client/v1/process	Create Process — بدء عملية تحقق
GET	/client/v1/process/{processId}	Get Process — جلب النتيجة
GET	/client/v1/process/{processId}/selfie	Get Selfie — تنزيل السيلفي (24 ساعة)

ما التالي

• Create Process — مرجع كامل للمعلمات لجميع التدفقات الخمسة
• Authentication — إنشاء وإدارة مفاتيح الوصول
• Build With LLM — الصق موجهاً في مساعد الذكاء الاصطناعي لإنشاء الدمج الكامل