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

# Accueil de l'API

***

L'API de Plenit vous permet de faire depuis vos propres outils la même chose que dans le tableau de bord : consulter des emplacements, des serveurs, des réseaux, des disques ou des règles de pare-feu, et automatiser leur gestion. Dans ce guide, vous effectuez votre premier appel et vérifiez que votre jeton fonctionne.

{% hint style="success" %}

#### **👍 Ce que vous obtenez**

Une première réponse de l'API de Plenit en quelques minutes, en utilisant votre propre jeton.
{% endhint %}

### Avant de commencer

* Avoir un jeton d'API actif et sa clé enregistrée. Si vous ne l'avez pas encore, consultez [Comment créer un jeton d'API](/fr/referencia/jetons-api/how-to-create-an-api-token.md).
* Disposer d'un outil pour effectuer des requêtes HTTP : la ligne de commande avec `curl`, ou un client comme Postman ou Insomnia.

{% hint style="warning" %}

#### **🚧 Il n'y a pas d'environnement de test**

Tous les appels s'exécutent sur votre infrastructure réelle. Pendant que vous vous familiarisez avec l'API :

* Commencez par des requêtes (`GET`), qui ne modifient rien.
* Utilisez un jeton avec le périmètre *My organization* au lieu de *All organizations*.
* Avant de créer, modifier ou supprimer des ressources, testez dans une organisation qui n'a pas de services clients.
  {% endhint %}

### Étape 1. Ayez à portée de main la clé de votre jeton

Chaque requête à l'API transporte la clé dans l'en-tête `Authorization`:

```
Authorization: Bearer <votre-jeton>
```

Remplacez `<votre-jeton>` par la clé que vous avez copiée lors de la création du jeton.

### Étape 2. Connaissez l'adresse de l'API

Toutes les requêtes relatives aux serveurs partent de cette adresse :

```
https://www.plenit.com/api/servers/v1
```

À cette adresse, on ajoute la ressource que vous souhaitez consulter, par exemple `/locations` pour les emplacements ou `/servers` pour les serveurs.

### Étape 3. Faites votre premier appel

Le moyen le plus simple de vérifier que tout fonctionne est de demander la liste des emplacements où vous pouvez déployer des serveurs. Cet appel ne nécessite aucun identifiant.

Depuis la ligne de commande :

```bash
curl https://www.plenit.com/api/servers/v1/locations \
  -H "Authorization: Bearer <votre-jeton>"
```

Dans Postman ou Insomnia, créez une requête `GET` à la même adresse et ajoutez l'en-tête `Authorization` avec la valeur `Bearer <votre-jeton>`.

### Étape 4. Vérifiez la réponse

Si le jeton est valide, l'API répond avec la liste des emplacements :

```json
{
  "data": [
    {
      "id": "33a3b2b8-6622-47cc-bc52-fdaeb4ecdaba",
      "name": "AZ-MAD1",
      "displayName": "MAD1",
      "region": "Madrid",
      "enabled": true
    }
  ],
  "metadata": {
    "records": {
      "totalItems": 2,
      "totalPages": 1,
      "currentPage": 1,
      "perPage": 20
    }
  }
}
```

Toutes les réponses suivent cette structure :

* `data`: les ressources que vous avez demandées.
* `metadata`: informations sur la réponse, comme le nombre total de résultats et la page sur laquelle vous vous trouvez.
* `links`: liens vers la page suivante et précédente lorsqu'il y a plus de résultats.

### Étapes suivantes

* [Comment faire des requêtes à l'API](/fr/referencia/how-to-make-api-requests.md): pagination, filtres, erreurs et utilisation depuis Postman ou Insomnia.
* Référence : toutes les ressources disponibles et leurs paramètres.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.plenit.com/fr/referencia/api-overview.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.