> For the complete documentation index, see [llms.txt](https://docs.g-iot.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.g-iot.io/fr/manual-dutilisation-de-la-plateforme/administration/api-swagger.md).

# API (Swagger)

Les **paramètres API** permettent de limiter les actions (Créer, Lire, Supprimer…) pouvant être effectuées selon la clé API utilisée.\
Chaque clé possède des **permissions spécifiques**, autorisant ou restreignant l’accès aux données tout en empêchant les mises à jour ou suppressions non autorisées.

Cela est particulièrement important pour la communication **machine-à-machine**, garantissant que chaque clé n’accède qu’aux opérations désignées.

De plus, les clés API peuvent être configurées pour **contrôler l’accès à des groupes ou appareils spécifiques**, assurant que seules les machines autorisées puissent interagir avec ces appareils.\
Cette fonctionnalité contribue à **prévenir toute utilisation non autorisée** de l’API.

<figure><img src="/files/RBorJ3T2JhN2sCqxdr6G" alt=""><figcaption><p>Page d'introduction Swagger API</p></figcaption></figure>

### Étapes pour Swagger API :

1. **Accéder au menu Administration** :
   * Assurez-vous que vous êtes dans le menu Cockpit, puis cliquez sur Administration.
2. **Accéder à la section API** :
   * Cliquez sur API pour être redirigé vers Swagger.
3. **Autoriser l'accès à l'API** :
   * Dans Swagger, cliquez sur le bouton Autoriser.
4. **Entrer la clé API** :
   * Fournissez la clé API pour compléter le processus d'authentification.

{% hint style="success" %}
Accédez à la DOCUMENTATION API ici : [https://app.gitbook.com/o/DKrl40rifuf7Bl8WIqXK/s/fEQ6KpTjmszWVWQqgcEa/\~/changes/283/.pdf-files-for-download/technical-.pdf](/.pdf-files-for-download/api-documetation.pdf.md)
{% endhint %}


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.g-iot.io/fr/manual-dutilisation-de-la-plateforme/administration/api-swagger.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.