⌘ K

ابدأ مع واجهة Instatus البرمجية

جميع نقاط النهاية تقع تحت الرابط https://api.instatus.com. وهي تتبع عمومًا نمط REST.

يجب ترميز جميع الطلبات بصيغة JSON مع الترويسة Content-Type: application/json.

كما تُرمَّز استجابات واجهة Instatus البرمجية، بما فيها الأخطاء، بصيغة JSON.

المصادقة

يجب أن توفّر الطلبات المُرسَلة إلى واجهة Instatus البرمجية رمز API عبر ترويسة Authorization:

يمكنك الحصول على مفتاح API من إعدادات المستخدم ← إعدادات المطوّر

Authorization: Bearer <API_KEY>

احصل على معرّف الصفحة

يمكنك العثور على معرّف الصفحة في لوحة التحكم باتباع هذه الخطوات: ١. اذهب إلى لوحة التحكم. ٢. انقر بزر الفأرة الأيمن على مشروعك في الزاوية العلوية اليسرى لفتح القائمة. ٣. انقر Copy Project ID فيُنسخ معرّف الصفحة إلى الحافظة.

الأخطاء

تحتوي جميع نقاط النهاية على رمز ورسالة داخل استجابات الخطأ.

{
  "error": {
    "code": "forbidden",
    "message": "Not authorized"
  }
}

قيم الحالة

حالات الصفحة الممكنة. هذه هي قيمة status التفصيلية التي تعيدها الواجهة البرمجية الحالية (الإصدار v2 وما بعده). أما نقطة النهاية القديمة summary.json وإشعارات الويب هوك فتستخدم صيغة مختصرة تقتصر على UP وHASISSUES وUNDERMAINTENANCE.