# Démarrer avec l’API Instatus

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

Tous les points de terminaison se trouvent sous l’URL `https://api.instatus.com`. Ils suivent généralement l’architecture REST.

Toutes les requêtes doivent être encodées en JSON avec l’en-tête `Content-Type: application/json`.

Les réponses de l’API Instatus, y compris les erreurs, sont également encodées en JSON.

## Authentification

Les requêtes vers l’API Instatus doivent fournir un jeton d’API via l’en-tête Authorization :

Vous pouvez récupérer votre clé d’API dans Paramètres du compte → [Paramètres développeur](https://dashboard.instatus.com/developer)

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

## Récupérer votre ID de page
Votre ID de page se trouve dans le tableau de bord en suivant ces étapes :
1. Allez dans votre tableau de bord.
2. Faites un clic droit sur votre projet en haut à gauche pour ouvrir le menu.
3. Cliquez sur **Copy Project ID** : votre ID de page est copié dans le presse-papiers.

![ID de la page](https://instatus.com/help/page_id.png)

## Erreurs

Tous les points de terminaison de l’API renvoient un code et un message dans leurs réponses d’erreur.

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

## Valeurs de statut

Statuts de page possibles. Il s’agit du `status` détaillé renvoyé par l’API actuelle (v2 et ultérieure). L’ancien point de terminaison `summary.json` et les [notifications par webhook](https://instatus.com/help/fr/webhooks) utilisent une forme condensée avec seulement `UP`, `HASISSUES` et `UNDERMAINTENANCE`.

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

Statuts de composant possibles :

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

Statuts d’incident possibles :

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

Statuts de maintenance possibles :

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

## Accéder aux points de terminaison :

- [Pages de statut](https://instatus.com/help/fr/api/status-pages)
- [Équipes](https://instatus.com/help/fr/api/workspaces)
- [Composants](https://instatus.com/help/fr/api/components)
- [Incidents](https://instatus.com/help/fr/api/incidents)
- [Mises à jour d’incident](https://instatus.com/help/fr/api/incident-updates)
- [Maintenances](https://instatus.com/help/fr/api/maintenances)
- [Mises à jour de maintenance](https://instatus.com/help/fr/api/maintenance-updates)
- [Modèles](https://instatus.com/help/fr/api/templates)
- [Avis généraux](https://instatus.com/help/fr/api/generic-notices)
- [Pannes](https://instatus.com/help/fr/api/outages)
- [Membres de l’équipe](https://instatus.com/help/fr/api/teammates)
- [Abonnés](https://instatus.com/help/fr/api/subscribers)
- [Métriques](https://instatus.com/help/fr/api/metrics)
- [Profil utilisateur](https://instatus.com/help/fr/api/user-profile)
- [Données publiques](https://instatus.com/help/fr/api/public-data)
- [Pages privées](https://instatus.com/help/fr/api/private-pages)
- [Groupes d’audience](https://instatus.com/help/fr/api/audience-groups)
- [Moniteurs](https://instatus.com/help/fr/api/monitors)
- [Intégrations de supervision](https://instatus.com/help/fr/api/monitoring-integrations)
- [Règles de routage](https://instatus.com/help/fr/api/routing-rules)
- [Politiques d’escalade](https://instatus.com/help/fr/api/escalation-policies)
- [Plannings d’astreinte](https://instatus.com/help/fr/api/on-call-schedules)