توثيق API

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

 

المصادقة

تتطلب جميع طلبات API المصادقة عبر مفتاح API يُرسل عبر الترويسة Authorization كما هو موضح أدناه.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://hublink.ma3loma.org/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

الأخطاء

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

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