توثيق API
تعلم كيفية الاتصال والتكامل مع API الخاص بنا.
المصادقة
جميع نقاط نهاية API تتطلب مفتاح API يتم إرساله بواسطة طريقة مصادقة Bearer.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://bagiqo.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://bagiqo.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
الأخطاء
تستخدم واجهتنا البرمجية أكواد حالة HTTP التقليدية للإشارة إلى نجاح أو فشل الطلب.
{
"errors": [
{
"title": "\u0644\u064a\u0633 \u0644\u062f\u064a\u0643 \u0625\u0630\u0646 \u0644\u0644\u0648\u0635\u0648\u0644 \u0625\u0644\u0649 \u0648\u0627\u062c\u0647\u0629 \u0628\u0631\u0645\u062c\u0629 \u0627\u0644\u062a\u0637\u0628\u064a\u0642\u0627\u062a.",
"status": 401
}
]
}
200 تم استكمال الطلب بنجاح
400 طلب غير صالح - المعلمات المطلوبة مفقودة أو غير صحيحة
401 غير مصرح - مفتاح API مفقود أو غير صالح
404 المورد المطلوب غير موجود
429 طلبات كثيرة جدًا - تم تجاوز حد المعدل
500 خطأ في الخادم الداخلي - هذا يعني أن هناك مشكلة من جانبنا
جميع نتائج نقاط نهاية API تعمل مع المنطقة الزمنية UTC ما لم يُذكر خلاف ذلك.
المستخدم
سجلات الحساب