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

Source: https://instatus.com/help/ar/api

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

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

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

## المصادقة

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

يمكنك الحصول على مفتاح API من إعدادات المستخدم ← [إعدادات المطوّر](https://dashboard.instatus.com/developer)

```bash
Authorization: Bearer <API_KEY>
```

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

![معرّف الصفحة](https://instatus.com/help/page_id.png)

## الأخطاء

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

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

## قيم الحالة

حالات الصفحة الممكنة. هذه هي قيمة `status` التفصيلية التي تعيدها الواجهة البرمجية الحالية (الإصدار v2 وما بعده). أما نقطة النهاية القديمة `summary.json` و[إشعارات الويب هوك](https://instatus.com/help/ar/webhooks) فتستخدم صيغة مختصرة تقتصر على `UP` و`HASISSUES` و`UNDERMAINTENANCE`.

- `UP`
- `HASISSUES`
- `ALLUNDERMAINTENANCE`
- `ALLDEGRADEDPERFORMANCE`
- `ALLPARTIALOUTAGE`
- `ALLMINOROUTAGE`
- `ALLMAJOROUTAGE`
- `SOMEUNDERMAINTENANCE`
- `SOMEDEGRADEDPERFORMANCE`
- `SOMEPARTIALOUTAGE`
- `SOMEMINOROUTAGE`
- `SOMEMAJOROUTAGE`
- `ONEUNDERMAINTENANCE`
- `ONEDEGRADEDPERFORMANCE`
- `ONEPARTIALOUTAGE`
- `ONEMINOROUTAGE`
- `ONEMAJOROUTAGE`

حالات المكوّن الممكنة:

- `OPERATIONAL`
- `UNDERMAINTENANCE`
- `DEGRADEDPERFORMANCE`
- `PARTIALOUTAGE`
- `MAJOROUTAGE`

حالات الحادثة الممكنة:

- `INVESTIGATING`
- `IDENTIFIED`
- `MONITORING`
- `RESOLVED`

حالات الصيانة الممكنة:

- `NOTSTARTEDYET`
- `INPROGRESS`
- `COMPLETED`

## انتقل إلى نقاط النهاية:

- [صفحات الحالة](https://instatus.com/help/ar/api/status-pages)
- [مساحات العمل](https://instatus.com/help/ar/api/workspaces)
- [المكوّنات](https://instatus.com/help/ar/api/components)
- [الحوادث](https://instatus.com/help/ar/api/incidents)
- [تحديثات الحوادث](https://instatus.com/help/ar/api/incident-updates)
- [أعمال الصيانة](https://instatus.com/help/ar/api/maintenances)
- [تحديثات الصيانة](https://instatus.com/help/ar/api/maintenance-updates)
- [القوالب](https://instatus.com/help/ar/api/templates)
- [الإشعارات العامة](https://instatus.com/help/ar/api/generic-notices)
- [الانقطاعات](https://instatus.com/help/ar/api/outages)
- [أعضاء الفريق](https://instatus.com/help/ar/api/teammates)
- [المشتركون](https://instatus.com/help/ar/api/subscribers)
- [المقاييس](https://instatus.com/help/ar/api/metrics)
- [الملف الشخصي](https://instatus.com/help/ar/api/user-profile)
- [البيانات العامة](https://instatus.com/help/ar/api/public-data)
- [الصفحات الخاصة](https://instatus.com/help/ar/api/private-pages)
- [مجموعات الجمهور](https://instatus.com/help/ar/api/audience-groups)
- [المراقبات](https://instatus.com/help/ar/api/monitors)
- [تكاملات المراقبة](https://instatus.com/help/ar/api/monitoring-integrations)
- [قواعد التوجيه](https://instatus.com/help/ar/api/routing-rules)
- [سياسات التصعيد](https://instatus.com/help/ar/api/escalation-policies)
- [جداول المناوبة](https://instatus.com/help/ar/api/on-call-schedules)