> For the complete documentation index, see [llms.txt](https://docs.rahona-hosting.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rahona-hosting.com/french/overview.md).

# Vue d'ensemble

## Authentification

Il existe actuellement un moyen de s'authentifier par le biais de l'API Rahona : la clé d'authentification. Cette clé peut être créée dans les paramètres du compte utilisateur.

Cette **clé** peut alors être utilisé dans l'en-tête `Headers` d'une requête HTTP :

Toutes les demandes doivent comprendre à la fois : **X-Rahona-Key** ainsi que **X-Rahona-Email** dans l'en-tête pour pouvoir s'identifier.

{% tabs %}
{% tab title="Exemple" %}

```bash
curl -X GET "https://api.rahona.network/servers/123" \
     -H "Content-Type:application/json" \
     -H "X-Rahona-Key:1234567893feefc5f0q5000bfo0c38d90bbeb" \
     -H "X-Rahona-Email:example@example.com"
```

{% endtab %}
{% endtabs %}

## Les erreurs

L'API Rahona utilise des codes de réponse HTTP classiques pour indiquer le succès ou l'échec d'une demande d'API.

En règle générale :

* Les codes dans l'intervalle `2xx` indique le succès
* Les codes dans l'intervalle `4xx` indiquent des paramètres incorrects ou incomplets (par exemple, un paramètre requis a été omis, une opération a échoué avec une tierce partie, etc.)
* Les codes dans l'intervalle `5xx` indiquent une erreur avec les serveurs Rahona Hosting 😢

L'API Rahona produit également un message d'erreur et un code d'erreur formaté en JSON :

{% code title="Exemple" %}

```php
{    "error": "Can't find any servers"    }
```

{% endcode %}

## Les limites

#### Accessibilité des données <a href="#data-accessibility" id="data-accessibility"></a>

L'API Rahona est disponible pour tous les utilisateurs de Rahona Hosting. Toutefois, les utilisateurs de plans plus importants ont accès à une plus grande sélection d'ensembles de données et peuvent effectuer des recherches sur des intervalles historiques plus larges.

#### Documents de l'équipe <a href="#data-accessibility" id="data-accessibility"></a>

Certains paramètres ne sont **utilisables que par le personnel**, veuillez les **ignorer** dans ces documents.

| Endpoints       | Client | Premium | Revendeur |
| --------------- | :----: | :-----: | :-------: |
| User            |   ✔️   |    ✔️   |     ✔️    |
| Invoices        |   ✔️   |    ✔️   |     ✔️    |
| Tickets         |   ✔️   |    ✔️   |     ✔️    |
| Servers         |   ✔️   |    ✔️   |     ✔️    |
| Servers actions |    ❌   |    ✔️   |     ✔️    |
| Servers graphs  |    ❌   |    ✔️   |     ✔️    |
| API - ADMIN     |    ❌   |    ❌    |     ❌     |