توثيق API

تعلم كيفية الاتصال والتكامل مع API الخاص بنا.

 

المصادقة

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

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

الأخطاء

تستخدم API الخاصة بنا أكواد حالة 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 ما لم يُذكر خلاف ذلك.
المستخدم
سجلات الحساب