# 開始使用 Instatus API

Source: https://instatus.com/help/zh-tw/api

所有端點都位於 `https://api.instatus.com` 之下，大致遵循 REST 架構。

所有請求都必須編碼為 JSON，並帶上 `Content-Type: application/json` 標頭。

Instatus API 的回應（包含錯誤）同樣以 JSON 編碼。

## 驗證

對 Instatus API 的請求必須透過 Authorization 標頭提供 API token：

你可以在使用者設定 → [開發者設定](https://dashboard.instatus.com/developer) 取得 API 金鑰

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

## 取得你的頁面 ID
依照下列步驟可以在儀表板中找到你的頁面 ID：
1. 前往你的儀表板。
2. 在左上角的專案上按右鍵開啟選單。
3. 點擊 **Copy Project ID**，頁面 ID 就會複製到剪貼簿。

![頁面 ID](https://instatus.com/help/page_id.png)

## 錯誤

所有 API 端點的錯誤回應都包含一個 code 與 message。

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

## 狀態值

可能的頁面狀態。這是目前 API（v2 及之後版本）回傳的細分 `status`。舊版的 `summary.json` 端點與 [webhook 通知](https://instatus.com/help/zh-tw/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/zh-tw/api/status-pages)
- [工作區](https://instatus.com/help/zh-tw/api/workspaces)
- [元件](https://instatus.com/help/zh-tw/api/components)
- [事件](https://instatus.com/help/zh-tw/api/incidents)
- [事件更新](https://instatus.com/help/zh-tw/api/incident-updates)
- [維護](https://instatus.com/help/zh-tw/api/maintenances)
- [維護更新](https://instatus.com/help/zh-tw/api/maintenance-updates)
- [範本](https://instatus.com/help/zh-tw/api/templates)
- [一般公告](https://instatus.com/help/zh-tw/api/generic-notices)
- [故障](https://instatus.com/help/zh-tw/api/outages)
- [團隊成員](https://instatus.com/help/zh-tw/api/teammates)
- [訂閱者](https://instatus.com/help/zh-tw/api/subscribers)
- [指標](https://instatus.com/help/zh-tw/api/metrics)
- [使用者資料](https://instatus.com/help/zh-tw/api/user-profile)
- [公開資料](https://instatus.com/help/zh-tw/api/public-data)
- [私密頁面](https://instatus.com/help/zh-tw/api/private-pages)
- [受眾群組](https://instatus.com/help/zh-tw/api/audience-groups)
- [監控](https://instatus.com/help/zh-tw/api/monitors)
- [監控整合](https://instatus.com/help/zh-tw/api/monitoring-integrations)
- [路由規則](https://instatus.com/help/zh-tw/api/routing-rules)
- [升級政策](https://instatus.com/help/zh-tw/api/escalation-policies)
- [待命排班](https://instatus.com/help/zh-tw/api/on-call-schedules)