دليل مطور e-KYC الآن

أنواع التدفق

التدفق الأساسي

تم تصميمه لسيناريوهات الإعداد منخفضة المخاطر حيث تكون السرعة أولوية.
يتحقق هذا التدفق من صحة وثائق الهوية الصادرة عن الحكومة باستخدام قواعد البيانات العالمية.

التدفق المتميز (الأكثر أمانًا)

تدفق التحقق الأكثر أمانًا لدينا.
يجمع بين التحقق من المستندات واكتشاف النشاط البيومتري وفحص مكافحة غسيل الأموال لتعزيز الامتثال ومنع الاحتيال.

بمجرد إنشاء التدفق، سيتم إنشاء معرف التدفق لكل من التدفقات الأساسية والمتميزة.

معرف التدفق هذا مطلوب لتكامل API ويجب تمريره في رؤوس الطلبات عند استدعاء واجهات برمجة تطبيقات KYC.

‍

إنشاء مفتاح API

• انتقل إلى قسم دليل المطور في وحدة التحكم وانقر على إنشاء مفتاح API.
• قم بنسخ مفتاح API الذي تم إنشاؤه وتخزينه بأمان، حيث سيكون مطلوبًا لجميع طلبات API.
• حافظ على سرية مفتاح API في جميع الأوقات؛ في حالة كشفه أو فقده أو اختراقه، قم بإنشاء مفتاح جديد على الفور.
• يرجى ملاحظة أنه يُسمح بمفتاح API نشط واحد فقط في كل مرة، وسيؤدي إنشاء مفتاح جديد إلى إبطال المفتاح السابق تلقائيًا.

استخدام التدفق التجريبي

لأغراض الاختبار، يمكنك استخدام ميزة Trial Flow المتوفرة في وحدة التحكم.

• للبدء، انسخ مفتاح واجهة برمجة التطبيقات التجريبية من قسم دليل المطور.

انتقل إلى صفحة إدارة التدفقات وانقر على أيقونة «+» للتدفق المطلوب.

• املأ التفاصيل المطلوبة وانقر فوق إنشاء. عند الإنشاء الناجح، سيتم توفير عنوان URL لإعادة توجيه KYC.

ملاحظة: عنوان URL الذي تم إنشاؤه صالح لمدة 30 دقيقة فقط ويجب استخدامه بدقة لأغراض الاختبار. لا تشارك عنوان URL هذا، لأنه يستخدم مرة واحدة ومحدد زمنياً. يُسمح لك بخمس (5) محاولات تجريبية مجانية فقط. في كل مرة يتم فيها إنشاء عنوان URL تجريبي، يتم استهلاك محاولة تجريبية واحدة.

نموذج عنوان URL التجريبي

https://ekyc-staging.messagecentral.com/kyc/flow/aEzRTHuaJcwda4WtETc119_S-ljpyGpeo0aLzz4705w

ملاحظة: يتم إنشاء نماذج عناوين URL التجريبية باستخدام معرف Flow المحدد مسبقًا.

لا تقم بتعديل أو استبدال معرف التدفق هذا بتدفق آخر، لأن القيام بذلك قد يؤدي إلى أخطاء غير متوقعة واستهلاك غير ضروري للاعتمادات التجريبية.

إنشاء عنوان URL من API

نقطة النهاية

بريد https://ekyc.messagecentral.com/ekyc/api/v1/redirection/generate-url

المصادقة والعناوين والجسم

يجب عليك تمرير العناوين والنصوص التالية مع كل طلب:

أمثلة على الرؤوس والجسم

معرف التدفق: جهاز قياس التدفق: HFBIYUFQ 9o9AAUFTBMKRI9KHPXL طاقم العمل LBVG64Jzim

مفتاح واجهة برمجة التطبيقات: حامل <YOUR API KEY>

اسم الشركة: <YOUR COMPANY NAME>

نوع المحتوى: التطبيق/json

مثال cURL

curl --location 'https://ekyc.messagecentral.com/ekyc/api/v1/redirection/generate-url' \

--header flow_id: FLOW_ID \

--header api_key: Bearer YOUR_API_KEY \

--form company_name="YOUR_COMPANY_NAME"

ملاحظة: يتم عرض flow_id و api_key في هذا المثال لأغراض العرض التوضيحي فقط. يجب استبدالها بالقيم الخاصة بك التي تم إنشاؤها من وحدة التحكم. لا تعرض أبدًا مفتاح API الخاص بك في التطبيقات من جانب العميل.

الاستجابة

استجابة النجاح (200 OK)

{

 "url": "https://ekyc.messagecentral.com/kyc/flow HfBIyufQ-9O9AauFtBMKRi9kHPXlStAfFlbvg64JzIM",

 "token": "HfBIyufQ-9O9AauFtBMKRi9kHPXlStAfFlbvg64JzIM",

 "journey_id": "M17682023316961BQG_SE",

 "expires_in_minutes": 30,

 "message": "Embed this URL in your application for KYC verification"

}

شرح حقول الاستجابة

ملاحظة: تنتهي صلاحية عنوان URL الذي تم إنشاؤه بعد الوقت المحدد. يجب عليك تجديده بعد انتهاء الصلاحية.

استجابات الأخطاء (401 غير مصرح بها)

1. اسم الشركة المفقود

{
 "detail": "Missing company name in Header"
}

تأكد من وجود company_name في نص الطلب.

2. تنسيق مفتاح API غير صالح

{

 "detail": "API Key must be 'Bearer '"

}

تأكد من أن مفتاح API مسبوقًا بـ Bearer.

3. معرف التدفق المفقود

{

 "detail": "Missing flow_id header/query."

}

تأكد من إرسال flow_id في رؤوس الطلبات.

إرشادات الأمان والاستخدام (مهمة)

يجب استدعاء واجهة برمجة التطبيقات هذه بدقة من خادم الواجهة الخلفية.

لا تتصل بواجهة برمجة التطبيقات هذه من تطبيقات الواجهة الأمامية

لا تتصل بواجهة برمجة التطبيقات هذه مباشرة من:

• المتصفح (ريكت، أنغلار، فيو، إلخ.)
• تطبيقات الأجهزة المحمولة (أندرويد/iOS)
• جافا سكريبت من جانب العميل

قد يؤدي الكشف عن واجهة برمجة التطبيقات هذه على الواجهة الأمامية تسرب مفتاح API الخاص بك، مما قد يؤدي إلى الوصول غير المصرح به وسوء الاستخدام.

أفضل ممارسات الأمان

قم دائمًا بتخزين api_key الخاص بك في:

• متغيرات البيئة
• المديرون السريون (مدير أسرار AWS، Vault، إلخ.)

قم بتدوير مفاتيح API بشكل دوري

قم بإعادة إنشاء عناوين URL فقط عند الحاجة (عناوين URL محددة زمنياً)

تحديد المعدلات/ملاحظة إساءة الاستخدام

ملاحظة: قد تكون الطلبات المفرطة أو المسيئة محدودة السعر لضمان استقرار النظام الأساسي.

للأسئلة والمخاوف، تواصل معنا!

support@messagecentral.com

https://www.messagecentral.com/

أسئلة متكررة