⌘ K

شروع کار با API Instatus

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

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

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

احرازهویت

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

می‌توانید کلید API خود را از تنظیمات کاربر ← تنظیمات توسعه‌دهنده بگیرید

Authorization: Bearer <API_KEY>

دریافت شناسه صفحه شما

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

خطاها

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

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

مقادیر وضعیت

وضعیت‌های ممکن صفحه. این همان status ریزدانه‌ای است که API فعلی (نسخه ۲ و بالاتر) برمی‌گرداند. نقطه پایانی قدیمی summary.json و اعلان‌های وب‌هوک از شکلی فشرده با تنها UP، HASISSUES و UNDERMAINTENANCE استفاده می‌کنند.