https://app.sahlfinancial.com/api بمفتاحك الخاص. لا يمرر هذا الموقع الطلب عبر وسيط ولا يخزّن مفتاحك.
ما تحتاج إليه
الخطوة 1. أنشئ مفتاح sandbox
لا يوجد مفتاح sandbox منفصل. يعمل المفتاح في البيئتين، وتختار كل مكالمة إحداهما عبر الحقلenvironment (القيمة الافتراضية sandbox). و”مفتاح sandbox” هو مفتاح لا تستخدمه إلا مع ضبط environment على sandbox.
- سجّل الدخول عبر app.sahlfinancial.com.
- افتح Settings ثم تبويب API Keys.
- انقر New key. سمّه
sandbox-test. - حدد النطاقات التي تريد اختبارها:
kyc:extractوkyc:verifyوkyc:eid. اترك Bound service account فارغاً. إذا ملأته فيجب أن ترسل كل مكالمة أيضاً رمز هوية Google فيX-Partner-Identity، وهو ما لا يستطيع playground فعله. - انقر Create API Key. يظهر السر مرة واحدة، بصيغة
sk_يتبعها 8 أحرف ثم شرطة سفلية و64 حرفاً. انسخه الآن. لا تستطيع وحدة التحكم عرضه مرة أخرى.
الخطوة 2. افتح playground
- افتح تبويب API reference في هذا الموقع، ثم Verify a profile.
- انقر Try it في أعلى يمين الصفحة.
- في الحقل Authorization الصق مفتاحك. الصق المفتاح وحده. يضيف playground الكلمة
Bearer. - اترك الخادم على
https://app.sahlfinancial.com/api.
يستدعي playground الـ API مباشرة من متصفحك. إذا فشل طلب بخطأ شبكة قبل ظهور أي رمز حالة، فقد حجبه متصفحك (CORS). نفّذ الطلب نفسه بـ cURL من نموذج الشيفرة في الصفحة، أو استخدم مجموعة Postman.
الخطوة 3. نفّذ الطلبات الستة
نفّذها بهذا الترتيب. كل طلب بضع نقرات.3.1 تحقق من ملف تعريفي
أرسل المثال الأدنى كما هو.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 اقرأ مستنداً
- افتح Read documents.
- اضبط
filesعلى قسيمة الراتب الوهمية. واضبطdoc_typeعلىpayslip، وreferenceعلىclient-0001، وenvironmentعلىsandbox، وkindعلىindividual. - أرسل.
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
افتح 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.