# Початок роботи з API Instatus

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

Усі ендпоінти доступні за URL `https://api.instatus.com`. Загалом вони відповідають архітектурі REST.

Усі запити мають бути закодовані як JSON із заголовком `Content-Type: application/json`.

Відповіді API Instatus, зокрема помилки, теж закодовані як JSON.

## Автентифікація

У запитах до API Instatus потрібно передавати токен API через заголовок Authorization:

Свій ключ API можна взяти в розділі «Налаштування користувача» → [Налаштування розробника](https://dashboard.instatus.com/developer)

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

## Отримати ID сторінки
ID сторінки можна знайти в панелі керування, виконавши такі кроки:
1. Перейдіть до панелі керування.
2. Клацніть проєкт у верхньому лівому куті правою кнопкою, щоб відкрити меню.
3. Натисніть **Copy Project ID** — ID сторінки скопіюється в буфер обміну.

![ID сторінки](https://instatus.com/help/page_id.png)

## Помилки

У відповідях з помилками всі ендпоінти API повертають код і повідомлення.

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

## Значення статусів

Можливі статуси сторінки. Це деталізований `status`, який повертає поточна версія API (v2 і новіші). Застарілий ендпоінт `summary.json` і [сповіщення через вебхуки](https://instatus.com/help/uk/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/uk/api/status-pages)
- [Робочі простори](https://instatus.com/help/uk/api/workspaces)
- [Компоненти](https://instatus.com/help/uk/api/components)
- [Інциденти](https://instatus.com/help/uk/api/incidents)
- [Оновлення інцидентів](https://instatus.com/help/uk/api/incident-updates)
- [Технічні роботи](https://instatus.com/help/uk/api/maintenances)
- [Оновлення про обслуговування](https://instatus.com/help/uk/api/maintenance-updates)
- [Шаблони](https://instatus.com/help/uk/api/templates)
- [Загальні оголошення](https://instatus.com/help/uk/api/generic-notices)
- [Збої](https://instatus.com/help/uk/api/outages)
- [Учасники команди](https://instatus.com/help/uk/api/teammates)
- [Підписники](https://instatus.com/help/uk/api/subscribers)
- [Метрики](https://instatus.com/help/uk/api/metrics)
- [Профіль користувача](https://instatus.com/help/uk/api/user-profile)
- [Публічні дані](https://instatus.com/help/uk/api/public-data)
- [Приватні сторінки](https://instatus.com/help/uk/api/private-pages)
- [Групи аудиторії](https://instatus.com/help/uk/api/audience-groups)
- [Монітори](https://instatus.com/help/uk/api/monitors)
- [Інтеграції моніторингу](https://instatus.com/help/uk/api/monitoring-integrations)
- [Правила маршрутизації](https://instatus.com/help/uk/api/routing-rules)
- [Політики ескалації](https://instatus.com/help/uk/api/escalation-policies)
- [Графіки чергувань](https://instatus.com/help/uk/api/on-call-schedules)