Skip to main content
يمكنك تشغيل كل نقاط النهاية من هذه الوثائق. يرسل API playground الطلب من متصفحك مباشرة إلى https://app.sahlfinancial.com/api بمفتاحك الخاص. لا يمرر هذا الموقع الطلب عبر وسيط ولا يخزّن مفتاحك.
استخدم عملاء ومستندات وهمية فقط. لا ترفع أبداً مستند عميل حقيقي.

ما تحتاج إليه

الخطوة 1. أنشئ مفتاح sandbox

لا يوجد مفتاح sandbox منفصل. يعمل المفتاح في البيئتين، وتختار كل مكالمة إحداهما عبر الحقل environment (القيمة الافتراضية sandbox). و”مفتاح sandbox” هو مفتاح لا تستخدمه إلا مع ضبط environment على sandbox.
  1. سجّل الدخول عبر app.sahlfinancial.com.
  2. افتح Settings ثم تبويب API Keys.
  3. انقر New key. سمّه sandbox-test.
  4. حدد النطاقات التي تريد اختبارها: kyc:extract وkyc:verify وkyc:eid. اترك Bound service account فارغاً. إذا ملأته فيجب أن ترسل كل مكالمة أيضاً رمز هوية Google في X-Partner-Identity، وهو ما لا يستطيع playground فعله.
  5. انقر Create API Key. يظهر السر مرة واحدة، بصيغة sk_ يتبعها 8 أحرف ثم شرطة سفلية و64 حرفاً. انسخه الآن. لا تستطيع وحدة التحكم عرضه مرة أخرى.
إذا فقدت السر، أنشئ مفتاحاً آخر وألغِ القديم. راجع المصادقة للاطلاع على التدوير.

الخطوة 2. افتح playground

  1. افتح تبويب API reference في هذا الموقع، ثم Verify a profile.
  2. انقر Try it في أعلى يمين الصفحة.
  3. في الحقل Authorization الصق مفتاحك. الصق المفتاح وحده. يضيف playground الكلمة Bearer.
  4. اترك الخادم على https://app.sahlfinancial.com/api.
جسم الطلب معبأ مسبقاً بعميل وهمي. اختر المثال المسمى Minimal profile, no documents إذا عرض playground خياراً.
يستدعي playground الـ API مباشرة من متصفحك. إذا فشل طلب بخطأ شبكة قبل ظهور أي رمز حالة، فقد حجبه متصفحك (CORS). نفّذ الطلب نفسه بـ cURL من نموذج الشيفرة في الصفحة، أو استخدم مجموعة Postman.

الخطوة 3. نفّذ الطلبات الستة

نفّذها بهذا الترتيب. كل طلب بضع نقرات.

3.1 تحقق من ملف تعريفي

أرسل المثال الأدنى كما هو.
المتوقع: HTTP 200 وجسم بالشكل التالي.
تختلف القيم في استجابتك: case_id معرّف حقيقي، وعدد الإدخالات في تفصيل الفحص (screening) هو حجم القائمة المحمّلة، وقد تضيف سياسة مساحة عملك فحوصاً. القيمة passed: true مع تحذير اكتمال هي النتيجة العادية هنا. اختُصر flags وcompleteness.missing أعلاه.

3.2 اجعله يفشل عمداً

اضبط require_documents على true وأرسل مرة أخرى. إذا سمحت سياسة مساحة عملك بذلك، فستحمل الاستجابة الآن passed: false وفحصاً حرجاً required:photo_id بالتفصيل no readable government photo ID among the uploads. يبين هذا شكل الملف المحظور.

3.3 اقرأ مستنداً

  1. افتح Read documents.
  2. اضبط files على قسيمة الراتب الوهمية. واضبط doc_type على payslip، وreference على client-0001، وenvironment على sandbox، وkind على individual.
  3. أرسل.
المتوقع: HTTP 200 مع fields وdocuments وfield_count وchecks وreader_unavailable وpolicy وcase_id وdocument_ids. قسيمة الراتب لا تعطي checks. وتتوقف الحقول العائدة على ما هو مطبوع في ملفك؛ راجع أنواع المستندات وحقولها. تُحتسب كل قراءة من حصتك الشهرية (2,000 قراءة افتراضياً).

3.4 قيّم المخاطر

افتح Verify and assess risk واختر المثال Profile with the suitability answers. أرسل. المتوقع: verification وassessment وregistry. وبقيم المثال يكون التقييم: ملف المخاطر 58 Balanced، والقدرة 20 Low، ومخاطر الامتثال Low أو Medium (بحسب سياستك وقائمة الفحص) وسلسلة suitability. راجع تقييم المخاطر لمعرفة كيفية بناء كل رقم.

3.5 اختياري: ابدأ فحص eID

هذه المكالمة حقيقية في sandbox أيضاً. يراسل مزود eID العميل بالبريد بـ PIN ورابط فور إنشاء الطلب. استخدم عنواناً تتحكم فيه. في هذا الإصدار يجب أن يكون العميل كندياً (CA أو CAN)، وهو البلد الوحيد الذي يقبله المحرك، وتحتاج مساحة عملك إلى حساب مزود eID خاص بها، وإلا أعادت المكالمة 404 identity verification is not set up for this tenant.
افتح Start an eID check، واضبط بريدك الإلكتروني، وأرسل. تحصل على HTTP 201 وkey. ثم افتح Get an eID check، وأدخل key وأرسل حتى تصبح complete تساوي true. راجع فحص eID.

الخطوة 4. اطلع على النتيجة في وحدة التحكم

لأن كل طلب حمل reference، فقد حفظت المكالمة حالة في مساحة عملك. تبدّل شارة البيئة في الشريط العلوي لوحدة التحكم ما تعرضه القوائم. التبديل إلى production يعمل في كل الخطط، ضمن حدود الخطة: تتضمن الخطة Free عشر (10) حالات Production في الشهر وتتطلب بريداً إلكترونياً مهنياً موثقاً (وليس Gmail أو Yahoo)، وSandbox غير محدود في كل الخطط.

عند الفشل

جميع أجسام الأخطاء موجودة في فهرس الأخطاء.

التالي

Postman

نفّذ الطلبات نفسها بمجموعة وسكربت اختبار.

الدليل الشامل

من قسيمة راتب وبطاقة تعريف وطنية مغربية إلى تقييم المخاطر، مع cURL وJavaScript وPython.