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.

Page d'introduction Swagger API

É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.

Accédez à la DOCUMENTATION API ici : https://app.gitbook.com/o/DKrl40rifuf7Bl8WIqXK/s/fEQ6KpTjmszWVWQqgcEa/~/changes/283/.pdf-files-for-download/technical-.pdf