كيفية الوصول إلى واجهة API
سجّل تطبيقًا في B2CORE IB Back Office، واختر مستوى وصوله، واستبدل بيانات اعتماده برمز وصول، ثم استدعِ IB API
تصل عمليات التكامل إلى B2CORE IB API نيابةً عن تطبيق مسجّل في Back Office. لكل تطبيق معرّف عميل وسرّ عميل ومستوى وصول يحدّد ما إذا كان بإمكانه تغيير البيانات. توضّح هذه المقالة كيفية تسجيل تطبيق وإجراء أول استدعاء لواجهة API.
تسجيل تطبيق
انتقل إلى الوسطاء المعرّفين > التفضيلات > التطبيقات.
انقر على تسجيل تطبيق جديد.
أدخل اسمًا للتطبيق في حقل اسم التطبيق.
اختر مستوى الوصول:
- Read-only (محدّد مسبقًا) — يمكن للتطبيق استدعاء جميع عمليات GET وإنشاء مهام التصدير؛ ويُرفض أي طلب آخر من نوع POST أو PUT أو PATCH أو DELETE يُرسَل باستخدام رمز وصول التطبيق. يُوصى به لعمليات التكامل الخاصة بالتقارير والمراقبة.
- Full access — يمكن للتطبيق استدعاء جميع عمليات واجهة API.
يمكنك تغيير مستوى الوصول لاحقًا من صفحة تفاصيل التطبيق. يسري التغيير على طلب واجهة API التالي الذي يرسله التطبيق.
انقر على حفظ.
ستُعاد توجيهك إلى صفحة تفاصيل التطبيق الذي أُنشئ حديثًا، حيث يمكنك عرض اسم التطبيق ومعرّف العميل وسرّ العميل ومستوى الوصول وقائمة عناوين IP المسموح بها.
انسخ معرّف العميل وسرّ العميل واحتفظ بهما في مكان تخزين آمن. يُستخدمان للتحقق من هويتك عند الوصول إلى واجهة API. يُعرض سرّ العميل مرة واحدة فقط، في هذه الصفحة — ولن تتمكن من عرضه مجددًا لاحقًا.
الحصول على رمز وصول
أرسل طلب POST إلى العملية /tokens باستخدام مصادقة HTTP Basic، مع استخدام معرّف العميل اسمًا للمستخدم وسرّ العميل كلمةً للمرور:
curl -X POST "{baseUrl}/tokens" \
-u "CLIENT_ID:CLIENT_SECRET" \
-H "Content-Type: application/json" \
-d '{"grant_type": "client_credentials"}'استبدل {baseUrl} بعنوان URL الأساسي لواجهة IB API الخاصة بك، والذي يزوّدك به فريق التكامل في B2BROKER.
انسخ قيمة access_token من الاستجابة. تحتوي الاستجابة أيضًا على token_type (Bearer) وexpires_in — مدة صلاحية الرمز بالثواني. يؤدي طلب رمز جديد إلى إبطال الرموز السابقة للتطبيق.
استدعاء واجهة API
مرّر الرمز في ترويسة Authorization لكل طلب:
curl "{baseUrl}/users" \
-H "Authorization: Bearer ACCESS_TOKEN"جميع العمليات مدرجة في مرجع واجهة API. تعرض كل عملية مستوى الوصول الذي تتطلبه: read (متاح لكل تطبيق) أو write (متاح فقط لتطبيقات Full access).
ماذا تعني استجابة 403
إذا استدعى تطبيق من مستوى Read-only عمليةً تتطلب وصول write، ترفض واجهة API الطلب برمز HTTP 403 والمحتوى التالي:
{
"error": {
"message": "This App is read-only and cannot perform this operation.",
"code": "insufficient_scope"
}
}تحقّق من حقل code: تعني insufficient_scope أن مستوى وصول التطبيق هو سبب الرفض. لإنجاح الطلب، إمّا أن تغيّر مستوى التطبيق إلى Full access من الوسطاء المعرّفين > التفضيلات > التطبيقات — يسري التغيير على الطلب التالي، ولا تحتاج إلى رمز جديد — أو أن تسجّل تطبيقًا منفصلًا بمستوى Full access لعملية التكامل التي تحتاج إلى تغيير البيانات.
الاستثناء الوحيد هو POST /exports/async: يُسمح لتطبيقات Read-only بإنشاء مهام التصدير، ما يتيح لعمليات التكامل الخاصة بالتقارير تصدير البيانات دون مستوى Full access.
آخر تحديث في