اربط تطبيقك بالبوابة
قدّم الاختبار من واجهتك، وتابع العملاء وتقاريرهم والرصيد من حسابك في البوابة.
ابدأ الربط
أنشئ مفتاحًا من إعدادات المطوّر واحتفظ به على خادمك. اضبط PORTAL_API_BASE على عنوان خادم البوابة المخصّص لبيئتك، متبوعًا بـ /partner/v1.
اختبر الاتصال أولًا. يعيد هذا الطلب صلاحيات المفتاح أيضًا. المفاتيح المخصّصة لاختبار الاتصال فقط لا تتيح تنفيذ الخطوات التالية.
export PORTAL_API_BASE='<PORTAL_BACKEND_ORIGIN>/partner/v1'
export PORTAL_API_KEY='<YOUR_SERVER_SIDE_KEY>'
curl --fail-with-body --request GET "$PORTAL_API_BASE/status" \
--header "Authorization: Bearer $PORTAL_API_KEY"احفظ كل معرّف وارد في متغيّر بيئة Bash قبل الطلب التالي. الأمثلة المعروضة لا تُنفّذ داخل المتصفح.
المراجع والتنزيلات
أضف عنوان الخادم والمفتاح محليًا بعد استيراد Postman. طلب إصدار التقرير يستهلك رصيدًا، ويجب توفير الإجابات الفعلية؛ المجموعة لا تُنشئ إجابات تجريبية تلقائيًا.
دليل الربط
واجهة API السابقة
مرجع للإصدار السابق فقط. معرّفات المزوّد والمسارات الواردة فيه لا تخصّ حسابات البوابة الحالية. فتح المرجع السابق
قبل تنفيذ الربط
أين تظهر البيانات الواردة من API؟
تظهر بيانات العملاء وتقاريرهم في أقسام البوابة المعتادة، ويظهر الخصم في صفحة الرصيد. يبقى externalId مرجعًا لربط أنظمتك، ولا يظهر في تقارير المستلمين أو رسائل البريد أو ملفات PDF.
هل يُرسل التقرير أو رابط الاختبار تلقائيًا؟
لا. هذه الخطوات تحفظ الاختبار وتُصدر تقرير المالك. مشاركة التقرير إجراء مستقل تنفّذه من البوابة.
كيف أعيد المحاولة بعد تعذّر الطلب؟
استخدم Idempotency-Key نفسه والبيانات نفسها عند إعادة طلب إنشاء الاختبار أو إصدار التقرير. تغيير البيانات مع المعرّف نفسه يعيد خطأ تعارض. الرمز 409 قد يعني أن الإجابات غير مكتملة، والرمز 402 يعني أن الرصيد لا يكفي. عالج السبب ثم أعد طلب التقرير بالمعرّف نفسه.
ما صلاحيات مفتاح الربط؟
يتيح تعديل بيانات العملاء، وإدارة الاختبارات المنشأة عبر API، وقراءة جميع التقارير الكاملة المتاحة للحساب، واستخدام رصيده. تنتهي صلاحيته بعد 90 يومًا، ويمكن إلغاؤه لإيقاف الوصول. لا تحتاج إلى معرّف مزوّد.