مصادقة API: تأمين طلبات KYC عبر API

العثور على مفتاح API الخاص بك

في Didit، تُخصَّص مفاتيح API لـ تطبيق محدد داخل حسابك. التطبيق هو مساحة عمل يمكنك من خلالها تكوين مسارات العمل وإدارة عمليات التحقق لمشروع معين أو بيئة محددة. يحصل كل تطبيق على مفتاح API أساسي يتمتع بصلاحية وصول كاملة عند إنشائه. يمكنك إضافة مفاتيح إضافية بجانبه، بحيث يمتلك كل منها فقط صلاحيات الوصول التي تحتاجها خدمة أو شريك معين. للعثور على مفاتيحك:

تسجيل الدخول إلى Business Console

انتقل إلى Didit Business Console وسجّل الدخول.

تحديد التطبيق الخاص بك

اختر التطبيق الذي تريد العمل معه من القائمة المنسدلة في الأعلى.

فتح مفاتيح API

انتقل إلى المطوّرون -> مفاتيح API في الشريط الجانبي الأيسر.

نسخ مفتاح أو إنشاؤه

المفتاح الأساسي هو السر الخاص بالتطبيق نفسه. أنشئ مفتاحاً جديداً لمنح خدمة أو شريك سراً خاصاً به، مع صلاحيات الوصول التي يحتاجها فقط.

مفتاح API الخاص بك هو سر — تعامل معه ككلمة مرور.يوفر المفتاح الأساسي وصولاً كاملاً إلى API نيابة عن تطبيقك. لا تكشف عنه أبداً في التعليمات البرمجية للواجهة الأمامية، أو المستودعات العامة، أو حزم جانب العميل. احتفظ به دائماً على جانب الخادم فقط.

تنسيق مفتاح API

تبدأ مفاتيح API الجديدة بـ sk_live_ لتطبيق بيئة الإنتاج أو sk_test_ لتطبيق البيئة التجريبية، متبوعة بـ 43 حرفًا آمنًا للاستخدام في عناوين URL (أحرف وأرقام و- و_). المفاتيح التي تم إنشاؤها قبل هذا التنسيق لا تحتوي على بادئة وتستمر في العمل دون تغيير. أرسل المفتاح بالكامل، بما في ذلك البادئة، في الرأس x-api-key، ولا ترفض مفتاحاً لمجرد أنه لا يحتوي على بادئة.

العثور على معرّف المؤسسة الخاص بك

معرّف المؤسسة الخاص بك هو معرّف فريد عالمياً (UUID) يحدد مؤسستك. يمكنك استخدامه في مسارات API المخصصة للمؤسسة مثل /auth/v2/organizations/me/{org_id}/applications/. يمكنك نسخه مباشرة من Business Console، دون الحاجة إلى أي استدعاء لـ API:

فتح إعدادات المؤسسة

في Didit Business Console, انتقل إلى إعدادات المؤسسة.

نسخ معرّف المؤسسة

يعرض حقل معرّف المؤسسة معرّف UUID الخاص بمؤسستك بجوار اسم المؤسسة، مع زر للنسخ إلى الحافظة.

إجراء الطلبات الموثقة

لمصادقة طلب API، قم بتضمين مفتاح API السري الخاص بك في رأس HTTP المسمى x-api-key. فيما يلي مثال على طلب موثق إلى endpoint الخاص بـ Create Session:

cURL

curl --request POST \
     --url https://verification.didit.me/v3/session/ \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'x-api-key: YOUR_API_KEY' \
     --data '
{
  "workflow_id": "WORKFLOW_ID",
  "vendor_data": "USER_ID",
  "callback": "CALLBACK_URL"
}
'

معالجة الأخطاء

إذا كان مفتاح API الخاص بك خاطئًا أو مشوّهًا أو أُلغي، فإن API يعيد 401 Unauthorized:

{
  "detail": "Authentication credentials were not provided or are invalid."
}

يعيد API أيضًا 401 للمفتاح المنتهي الصلاحية، مع "detail": "This API key has expired.". يعيد API 403 للطلب الذي لا يحتوي على مفتاح مع "detail": "You do not have permission to perform this action.".

رمز الحالة	المعنى
401	مفتاح API خاطئ، أو مشوّه، أو ملغى، أو منتهي الصلاحية
403	لم يتم إرسال مفتاح API، أو أن المفتاح لا يمتلك صلاحية الوصول إلى المورد أو الإجراء المطلوب، أو أن الطلب وارد من عنوان خارج قائمة عناوين IP الخاصة بالمفتاح
403 مع `"code": "application_deleted"`	المفتاح ينتمي إلى تطبيق تم حذفه. يعيد API هذه الاستجابة لبضع دقائق بعد الحذف، ثم يرفض المفتاح كأي مفتاح غير صالح. لا تعاود المحاولة: التطبيق ومفاتيحه لم تعد موجودة.
404	في مسار جلسة: الجلسة خارج نطاق مسارات العمل أو الحالات المحددة للمفتاح

تسرد صفحة أخطاء API كل حالة ونص استجابة ورمز.

مفاتيح API محددة النطاق

امنح كل خدمة أو شريك مفتاحاً خاصاً به بدلاً من مشاركة المفتاح الأساسي. يمتلك كل مفتاح صلاحيات وصول خاصة به: بلا وصول، أو قراءة، أو كتابة لكل مورد (الجلسات، والقرارات، والوسائط، والأشخاص، والشركات، والمعاملات، ومسارات العمل، وwebhook، وإعدادات التطبيق، والتحليلات)، وقيود اختيارية لبعض مسارات العمل، أو للجلسات المقبولة فقط، أو لقائمة من عناوين IP، ولتاريخ انتهاء الصلاحية. يمكنك تدوير مفتاح مع فترة تداخل مدتها 24 ساعة، وإلغاؤه على الفور. تحتفظ المفاتيح التي تم إنشاؤها قبل إتاحة الوصول محدد النطاق بصلاحيات وصول كاملة. راجع مفاتيح API للاطلاع على الإعدادات المسبقة، والموارد التي يغطيها كل منها، وكيفية استجابة API لمفتاح محدد النطاق.

إذا تلقيت خطأ 401، فتأكد جيداً من أنك تستخدم مفتاح API الصحيح للتطبيق المناسب وأنه لم تتم إعادة إنشائه.

نظرة عامة

الأسعار

سير العمل والتحقق

المراجعة والعمليات

الكيانات (المستخدمون والشركات)

الإعدادات والتخصيص

الأمان والامتثال

Didit Academy

الموارد

مصادقة API: تأمين طلبات KYC عبر API

العثور على مفتاح API الخاص بك

تنسيق مفتاح API

العثور على معرّف المؤسسة الخاص بك

إجراء الطلبات الموثقة

معالجة الأخطاء

مفاتيح API محددة النطاق

​العثور على مفتاح API الخاص بك

​تنسيق مفتاح API

​العثور على معرّف المؤسسة الخاص بك

​إجراء الطلبات الموثقة

​معالجة الأخطاء

​مفاتيح API محددة النطاق

العثور على مفتاح API الخاص بك

تنسيق مفتاح API

العثور على معرّف المؤسسة الخاص بك

إجراء الطلبات الموثقة

معالجة الأخطاء

مفاتيح API محددة النطاق