# Aloita Instatus-API:n käyttö

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

Kaikki päätepisteet ovat URL-osoitteen `https://api.instatus.com` alla. Ne noudattavat pääosin REST-arkkitehtuuria.

Kaikki pyynnöt on koodattava JSON-muotoon ja niissä on käytettävä otsaketta `Content-Type: application/json`.

Myös Instatus-API:n vastaukset, virheet mukaan lukien, on koodattu JSON-muotoon.

## Todennus

Instatus-API:n pyynnöissä on annettava API-token Authorization-otsakkeessa:

Saat API-avaimesi kohdasta Käyttäjäasetukset → [Kehittäjäasetukset](https://dashboard.instatus.com/developer)

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

## Hae sivun ID
Löydät sivun ID:n hallintapaneelista näillä vaiheilla:
1. Siirry hallintapaneeliin.
2. Napsauta projektiasi vasemmassa yläkulmassa hiiren oikealla painikkeella avataksesi valikon.
3. Napsauta **Kopioi projektin ID**, niin sivun ID kopioituu leikepöydällesi.

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

## Virheet

Kaikki API-päätepisteet sisältävät koodin ja viestin virhevastauksissaan.

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

## Tila-arvot

Mahdolliset sivun tilat. Tämä on tarkka `status`, jonka nykyinen API (v2 ja uudemmat) palauttaa. Vanha `summary.json`-päätepiste ja [webhook-ilmoitukset](https://instatus.com/help/fi/webhooks) käyttävät tiivistettyä muotoa, jossa on vain `UP`, `HASISSUES` ja `UNDERMAINTENANCE`.

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

Mahdolliset komponentin tilat:

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

Mahdolliset häiriön tilat:

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

Mahdolliset huollon tilat:

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

## Siirry päätepisteisiin:

- [Statussivut](https://instatus.com/help/fi/api/status-pages)
- [Työtilat](https://instatus.com/help/fi/api/workspaces)
- [Komponentit](https://instatus.com/help/fi/api/components)
- [Häiriöt](https://instatus.com/help/fi/api/incidents)
- [Häiriöpäivitykset](https://instatus.com/help/fi/api/incident-updates)
- [Huollot](https://instatus.com/help/fi/api/maintenances)
- [Huoltopäivitykset](https://instatus.com/help/fi/api/maintenance-updates)
- [Mallipohjat](https://instatus.com/help/fi/api/templates)
- [Yleiset tiedotteet](https://instatus.com/help/fi/api/generic-notices)
- [Katkokset](https://instatus.com/help/fi/api/outages)
- [Tiimin jäsenet](https://instatus.com/help/fi/api/teammates)
- [Tilaajat](https://instatus.com/help/fi/api/subscribers)
- [Mittarit](https://instatus.com/help/fi/api/metrics)
- [Käyttäjäprofiili](https://instatus.com/help/fi/api/user-profile)
- [Julkinen data](https://instatus.com/help/fi/api/public-data)
- [Yksityiset sivut](https://instatus.com/help/fi/api/private-pages)
- [Yleisöryhmät](https://instatus.com/help/fi/api/audience-groups)
- [Monitorit](https://instatus.com/help/fi/api/monitors)
- [Valvontaintegraatiot](https://instatus.com/help/fi/api/monitoring-integrations)
- [Reitityssäännöt](https://instatus.com/help/fi/api/routing-rules)
- [Eskalointikäytännöt](https://instatus.com/help/fi/api/escalation-policies)
- [Päivystysaikataulut](https://instatus.com/help/fi/api/on-call-schedules)