توثيق الـ API
تعرف على كيفية الاتصال والاندماج مع واجهة برمجة التطبيقات (API) الخاصة بنا.
المصادقة
تتطلب جميع طلبات الـ API مصادقة من خلال مفتاح API يتم إرساله عبر ترويسة Authorization كما هو موضح أدناه.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://oo.om/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://oo.om/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 \u0628\u0631\u0645\u062c\u0629 \u0627\u0644\u062a\u0637\u0628\u064a\u0642\u0627\u062a (API).",
"status": 401
}
]
}
200 تم تنفيذ الطلب بنجاح
400 طلب سيئ - بعض المعلمات المطلوبة مفقودة أو غير صالحة
401 غير مصرح به - مفتاح الـ API مفقود أو غير صالح
404 لم يتم العثور على المورد المطلوب
429 طلبات كثيرة جداً - تم تجاوز حد معدل الطلب
500 خطأ داخلي في الخادم - هذا يعني وجود مشكلة من جانبنا
تعمل جميع نتائج نقاط نهاية الـ API وفقًا لـ منطقة UTC الزمنية ما لم ينص على خلاف ذلك.
المستخدم
الروابط
إحصائيات الروابط
بكسلات التتبع
صفحات العرض المؤقتة
رموز QR
البيانات
معالجات الإشعارات
النطاقات المخصصة
الفرق
أعضاء الفريق
عضو الفريق
مدفوعات الحساب
سجلات الحساب