Configurer l'API
Dans cet article, vous découvrirez comment configurer vos clés API et leurs différents droits d’accès.
Pour découvrir toutes les fonctionnalités de l’API, consultez notre documentation technique.
Configurer les clés d’accès
Dendreo vous permet de configurer plusieurs clés d’accès pour votre API depuis la page de configuration. Cela peut vous être utile notamment si plusieurs entités et services utilisent votre API.
Attention : ces clés sont uniques et privées. Ne les exposez pas publiquement, vous risqueriez de divulguer vos données confidentielles !
- Saisissez un nom puis cliquez sur Ajouter une nouvelle clé API.
- Sélectionnez les droits de lecture (GET) et d’écriture (POST, PUT, DELETE) pour chaque fonctionnalité (ou endpoint), afin de donner les bons droits aux bonnes personnes. Affinez si besoin chaque endpoint en cliquant sur l’icône de flèche.
À noter : dans le contexte des API, les endpoints sont des URL reliées à une fonctionnalité Dendreo.
Pour revenir plus tard sur la configuration de ces droits, cliquez sur l’icône de clé.
- Copiez la clé dans le presse-papier en cliquant sur l’icône ci-dessous, puis envoyez la clé à la personne ou au service en charge de votre API.
Vous pouvez à tout moment couper les accès à l’API à un service en un seul clic et sans impacter les autres soit en les révoquant (1), soit en les supprimant (2).
Depuis la page de configuration de l'API, vous retrouvez également le nombre de requêtes effectuées par l'API sur différentes périodes. Pour en savoir plus, consultez notre documentation dédiée.
Configurer les options supplémentaires
Depuis la rubrique Options de la configuration de l’API, vous pouvez choisir de restreindre l’API à une liste d’IP spécifique (en séparant chaque IP par un saut de ligne ou une virgule) : cette option ajoute une sécurité supplémentaire en empêchant les adresses IP non autorisées d’utiliser votre API.
Vous pouvez aussi activer/désactiver les alertes envoyées aux administrateurs de la vue globale lorsque les limites de quota API sont proches ou atteintes, et ajouter une ou plusieurs personnes en copies de ces alertes.
| Article précédent : Présentation de l'API |
Article suivant : Consulter l’usage de l’API |