وثائق واجهة برمجة التطبيقات

تعرف على كيفية الاتصال والتكامل مع واجهة برمجة التطبيقات (API) الخاصة بنا.

 

المصادقة

تتطلب جميع نقاط نهاية واجهة برمجة التطبيقات (API) مفتاح واجهة برمجة التطبيقات (API) الذي يتم إرساله بواسطة طريقة Bearer Authentication (مصادقة الحامل).

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://mybotsy.com/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

الأخطاء

تستخدم واجهة برمجة التطبيقات الخاصة بنا رموز حالة HTTP التقليدية للإشارة إلى نجاح الطلب أو فشله.

{
    "errors": [
        {
            "title": "\u0644\u064a\u0633 \u0644\u062f\u064a\u0643 \u062d\u0642 \u0627\u0644\u0648\u0635\u0648\u0644 \u0625\u0644\u0649 API.",
            "status": 401
        }
    ]
}
200 اكتمل الطلب بنجاح
400 طلب غير صالح - المعلمات المطلوبة مفقودة أو غير صالحة
401 غير مصرح به - مفتاح API مفقود أو غير صالح
404 لم يتم العثور على المورد المطلوب
429 طلبات كثيرة جدًا - تم تجاوز الحد الأقصى للسعر
500 خطأ داخلي في الخادم - وهذا يعني أن هناك مشكلة من جانبنا
تعمل جميع نتائج نقاط نهاية واجهة برمجة التطبيقات (API) مع المنطقة الزمنية UTC ما لم يتم تحديد خلاف ذلك.
المستخدم
فرق
أعضاء الفريق
عضو الفرق
سجلات الحساب