# Začínáme s API Instatusu

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

Všechny endpointy jsou pod URL `https://api.instatus.com`. Obecně se drží architektury REST.

Všechny požadavky musí být zakódované jako JSON s hlavičkou `Content-Type: application/json`.

Odpovědi z API Instatusu, včetně chyb, jsou také zakódované jako JSON.

## Ověřování

Požadavky na API Instatusu musí obsahovat API token v hlavičce Authorization:

Svůj API klíč najdete v Nastavení uživatele → [Nastavení pro vývojáře](https://dashboard.instatus.com/developer)

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

## Získání ID stránky
ID stránky najdete v dashboardu takto:
1. Přejděte do dashboardu.
2. Klikněte pravým tlačítkem na projekt v levém horním rohu a otevřete menu.
3. Klikněte na **Copy Project ID** a ID stránky se zkopíruje do schránky.

![ID stránky](https://instatus.com/help/page_id.png)

## Chyby

Všechny endpointy API vracejí v chybových odpovědích kód a zprávu.

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

## Hodnoty stavů

Možné stavy stránky. Tohle je podrobný `status`, který vrací současné API (v2 a novější). Starší endpoint `summary.json` a [oznámení přes webhook](https://instatus.com/help/cs/webhooks) používají zjednodušenou podobu jen s `UP`, `HASISSUES` a `UNDERMAINTENANCE`.

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

Možné stavy komponenty:

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

Možné stavy incidentu:

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

Možné stavy údržby:

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

## Přejít na endpointy:

- [Stavové stránky](https://instatus.com/help/cs/api/status-pages)
- [Workspacy](https://instatus.com/help/cs/api/workspaces)
- [Komponenty](https://instatus.com/help/cs/api/components)
- [Incidenty](https://instatus.com/help/cs/api/incidents)
- [Aktualizace incidentů](https://instatus.com/help/cs/api/incident-updates)
- [Údržby](https://instatus.com/help/cs/api/maintenances)
- [Aktualizace údržby](https://instatus.com/help/cs/api/maintenance-updates)
- [Šablony](https://instatus.com/help/cs/api/templates)
- [Obecná oznámení](https://instatus.com/help/cs/api/generic-notices)
- [Výpadky](https://instatus.com/help/cs/api/outages)
- [Členové týmu](https://instatus.com/help/cs/api/teammates)
- [Odběratelé](https://instatus.com/help/cs/api/subscribers)
- [Metriky](https://instatus.com/help/cs/api/metrics)
- [Profil uživatele](https://instatus.com/help/cs/api/user-profile)
- [Veřejná data](https://instatus.com/help/cs/api/public-data)
- [Soukromé stránky](https://instatus.com/help/cs/api/private-pages)
- [Skupiny publika](https://instatus.com/help/cs/api/audience-groups)
- [Monitory](https://instatus.com/help/cs/api/monitors)
- [Integrace monitoringu](https://instatus.com/help/cs/api/monitoring-integrations)
- [Pravidla směrování](https://instatus.com/help/cs/api/routing-rules)
- [Eskalační zásady](https://instatus.com/help/cs/api/escalation-policies)
- [Rozpisy pohotovostí](https://instatus.com/help/cs/api/on-call-schedules)