المطورين
developer
api
headless
تكامل API Headless (نظرة عامة)
قاعدة المعرفة
المطورين
1الثقة والخصوصية
1برنامج الشركاء
1تكامل API Headless (نظرة عامة)
إذا كنت ترغب في بناء واجهة المستخدم الخاصة بالتقييم (ويب/جوال) والتكامل مع B5.ly عبر API:
- مرجع تفاعلي:
/developer/b5plus-v2.reference.html - مواصفات OpenAPI:
/developer/b5plus-v2.openapi.yaml - مجموعة Postman:
/developer/b5plus-v2.postman.json - دليل تكامل الشركاء:
/developer/b5plus-partner-headless-guide.md
سير العمل الموصى به:
- بدء جلسة التقييم (v1)
- جلب العناصر وعرض الأسئلة
- إرسال الإجابات وإنهاء الجلسة للحصول على
resultId - إنشاء تقرير مدفوع (v2) للحصول على
reportId - جلب تقرير JSON وعرض النتائج
الظهور في البوابة:
- في بوابة الشركاء، يمكنك عرض سجل تدقيق لعمليات شراء التقارير (خصم الأرصدة + معرّفات التقرير + معرّفات النتيجة) عبر
/portal/activity(معرّفات التقرير تفتح عرض التقرير داخل البوابة). - استخدم فلتر المصدر (الكل / البوابة / API) وخيار تصدير CSV للمطابقة.
- معرّف النتيجة (Result ID) هو نفسه
resultIdفي تدفق الـ headless (وقد يظهر كـextResultId/ext_result_id). - لأن استدعاءات الـ API headless لا تُنشئ صفوف العملاء/القوائم/التقارير تلقائياً، قد لا تتضمن تقارير API في البوابة الاسم/البريد/القائمة/الباقة (وقد يظهر مُعرّف بديل مثل
API-<ResultID>عند الحاجة). - جداول العملاء/القوائم/التقارير داخل البوابة تعتمد على تدفقات الدعوات/القوائم؛ استدعاءات الـ API headless لا تُنشئ هذه الصفوف تلقائياً.
- احفظ
partnerUserRefوresultIdوreportIdفي نظامك إذا كنت تحتاج إلى مطابقة/مراجعة على مستوى العميل.