# Bắt đầu với API Instatus

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

Mọi endpoint đều nằm dưới URL `https://api.instatus.com`. Chúng nhìn chung tuân theo kiến trúc REST.

Mọi yêu cầu phải được mã hóa dưới dạng JSON kèm header `Content-Type: application/json`.

Phản hồi từ API Instatus, kể cả lỗi, cũng được mã hóa dưới dạng JSON.

## Xác thực

Các yêu cầu tới API Instatus phải cung cấp một token API qua header Authorization:

Bạn có thể lấy khóa API từ Cài đặt người dùng → [Cài đặt nhà phát triển](https://dashboard.instatus.com/developer)

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

## Lấy ID trang của bạn
Bạn có thể tìm ID trang trong dashboard theo các bước sau:
1. Vào dashboard của bạn.
2. Nhấp chuột phải vào dự án ở góc trên bên trái để mở menu.
3. Nhấp **Copy Project ID** và ID trang của bạn sẽ được sao chép vào clipboard.

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

## Lỗi

Mọi endpoint API đều chứa một mã và một thông điệp trong phản hồi lỗi.

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

## Các giá trị trạng thái

Các trạng thái trang có thể có. Đây là giá trị `status` chi tiết do API hiện tại (v2 trở lên) trả về. Endpoint `summary.json` cũ và [thông báo webhook](https://instatus.com/help/vi/webhooks) dùng dạng rút gọn chỉ gồm `UP`, `HASISSUES` và `UNDERMAINTENANCE`.

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

Các trạng thái thành phần có thể có:

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

Các trạng thái sự cố có thể có:

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

Các trạng thái bảo trì có thể có:

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

## Chuyển đến các endpoint:

- [Trang trạng thái](https://instatus.com/help/vi/api/status-pages)
- [Workspace](https://instatus.com/help/vi/api/workspaces)
- [Thành phần](https://instatus.com/help/vi/api/components)
- [Sự cố](https://instatus.com/help/vi/api/incidents)
- [Cập nhật sự cố](https://instatus.com/help/vi/api/incident-updates)
- [Bảo trì](https://instatus.com/help/vi/api/maintenances)
- [Cập nhật bảo trì](https://instatus.com/help/vi/api/maintenance-updates)
- [Mẫu](https://instatus.com/help/vi/api/templates)
- [Thông báo chung](https://instatus.com/help/vi/api/generic-notices)
- [Gián đoạn](https://instatus.com/help/vi/api/outages)
- [Thành viên nhóm](https://instatus.com/help/vi/api/teammates)
- [Người đăng ký](https://instatus.com/help/vi/api/subscribers)
- [Chỉ số](https://instatus.com/help/vi/api/metrics)
- [Hồ sơ người dùng](https://instatus.com/help/vi/api/user-profile)
- [Dữ liệu công khai](https://instatus.com/help/vi/api/public-data)
- [Trang riêng tư](https://instatus.com/help/vi/api/private-pages)
- [Nhóm đối tượng](https://instatus.com/help/vi/api/audience-groups)
- [Monitor](https://instatus.com/help/vi/api/monitors)
- [Tích hợp giám sát](https://instatus.com/help/vi/api/monitoring-integrations)
- [Quy tắc định tuyến](https://instatus.com/help/vi/api/routing-rules)
- [Chính sách leo thang](https://instatus.com/help/vi/api/escalation-policies)
- [Lịch trực](https://instatus.com/help/vi/api/on-call-schedules)