# شروع کار با API Instatus

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

همه نقاط پایانی زیر نشانی `https://api.instatus.com` هستند. آن‌ها عموماً از معماری REST پیروی می‌کنند.

همه درخواست‌ها باید با هدر `Content-Type: application/json` به‌صورت JSON کدگذاری شوند.

پاسخ‌های API Instatus، از جمله خطاها، نیز به‌صورت JSON کدگذاری می‌شوند.

## احرازهویت

درخواست‌ها به API Instatus باید یک توکن API را از طریق هدر Authorization ارائه دهند:

می‌توانید کلید API خود را از تنظیمات کاربر ← [تنظیمات توسعه‌دهنده](https://dashboard.instatus.com/developer) بگیرید

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

## دریافت شناسه صفحه شما
شناسه صفحه شما را می‌توان با این گام‌ها در داشبورد پیدا کرد:
۱. به داشبورد خود بروید.
۲. روی پروژه‌تان در گوشه بالا-سمت چپ راست‌کلیک کنید تا منو باز شود.
۳. روی **Copy Project ID** کلیک کنید تا شناسه صفحه‌تان در حافظه کپی شود.

![شناسه صفحه](https://instatus.com/help/page_id.png)

## خطاها

همه نقاط پایانی API در پاسخ‌های خطا یک code و message دارند.

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

## مقادیر وضعیت

وضعیت‌های ممکن صفحه. این همان `status` ریزدانه‌ای است که API فعلی (نسخه ۲ و بالاتر) برمی‌گرداند. نقطه پایانی قدیمی `summary.json` و [اعلان‌های وب‌هوک](https://instatus.com/help/fa/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/fa/api/status-pages)
- [فضاهای کاری](https://instatus.com/help/fa/api/workspaces)
- [اجزا](https://instatus.com/help/fa/api/components)
- [حوادث](https://instatus.com/help/fa/api/incidents)
- [به‌روزرسانی حوادث](https://instatus.com/help/fa/api/incident-updates)
- [نگهداری‌ها](https://instatus.com/help/fa/api/maintenances)
- [به‌روزرسانی‌های تعمیرات](https://instatus.com/help/fa/api/maintenance-updates)
- [قالب‌ها](https://instatus.com/help/fa/api/templates)
- [اطلاعیه‌های عمومی](https://instatus.com/help/fa/api/generic-notices)
- [اختلال‌ها](https://instatus.com/help/fa/api/outages)
- [اعضای تیم](https://instatus.com/help/fa/api/teammates)
- [مشترکان](https://instatus.com/help/fa/api/subscribers)
- [شاخص‌ها](https://instatus.com/help/fa/api/metrics)
- [پروفایل کاربر](https://instatus.com/help/fa/api/user-profile)
- [داده‌های عمومی](https://instatus.com/help/fa/api/public-data)
- [صفحه‌های خصوصی](https://instatus.com/help/fa/api/private-pages)
- [گروه‌های مخاطب](https://instatus.com/help/fa/api/audience-groups)
- [مانیتورها](https://instatus.com/help/fa/api/monitors)
- [یکپارچه‌سازی‌های نظارت](https://instatus.com/help/fa/api/monitoring-integrations)
- [قواعد مسیریابی](https://instatus.com/help/fa/api/routing-rules)
- [سیاست‌های تشدید](https://instatus.com/help/fa/api/escalation-policies)
- [زمان‌بندی‌های آماده‌باش](https://instatus.com/help/fa/api/on-call-schedules)