Configurer l'API
Dans cet article, vous découvrirez comment configurer vos clés API et leurs différents droits d’accès. Vous apprendrez également comment consulter votre usage de l’API ainsi que ses logs d’activité.
Pour découvrir toutes les fonctionnalités proposées par 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).
Consulter l’usage de l’API
Sur la page de configuration de l'API, vous retrouvez votre usage de l'API sur les 30 derniers jours ainsi que sur les trois périodes précédentes :
Une limite de requêtes mensuelles, calculée sur 30 jours glissants, est appliquée selon votre niveau d'abonnement :
- Bronze (ou Pro) : 3 000 requêtes
- Argent (ou Premium) : 30 000 requêtes
- Or (ou Elite) : 100 000 requêtes
- Platine : requêtes illimitées
Il est donc important d'optimiser vos requêtes en fonction de votre abonnement pour ne pas vous retrouver bloqués.
À noter : il vous est possible d'acheter des packs de requêtes supplémentaires si besoin. Pour cela, contactez notre équipe support !
Attention : il n'est pas possible de faire plus de 100 requêtes en 10 secondes, ni plus de 100 000 requêtes par jour, quel que soit votre niveau d'abonnement.
Configurer les options
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.
Consulter les logs API
Depuis le tableau Log API, consultez l’activité de l’API sur une période donnée, par exemple l’activité liée à une clé API spécifique :
Vous pouvez également décider de voir uniquement les erreurs :
Cliquez sur le code HTTP pour afficher les paramètres passés dans la requête :
| Article précédent : Présentation de l'API |
Article suivant : Présentation des Webhooks |