Administration des clés d'API
Introduction
Afin de pouvoir utiliser l’API publique permettant aux développeurs de manipuler certaines données d’Essentiel, il est nécessaire de s’authentifier.
Pour cela, les administrateurs de l’application doivent générer une clé d’API depuis la section Administration des clés d’API disponible dans la page Administration > Général.
Une clé d’API se compose des éléments suivants :
Champ | Obligatoire ? | Unique ? | Description |
|---|---|---|---|
Libellé |
|
| Libellé de la clé dAPI permettant notamment de définir le contexte dans laquelle cette dernière sera utilisée. |
Token |
|
| Cette valeur est générée automatiquement par l’application et ne peut être visualisée qu’une seule fois lors de la création de la clé d’API. Pour des questions de sécurité, cette valeur ne peut pas être retrouvée. Si elle n’est pas sauvegardée par un administrateur dans un espace sécurisé de son choix, ce dernier devra révoquer la clé d’API, générer une nouvelle clé d’API et remplacer l’ancienne par la nouvelle dans TOUTES les intégrations où elle est utilisée. |
Liste des clés d’API
Liste des clés d’API générées
Générer une clé d’API
Il est possible de générer une clé d’API en cliquant sur le bouton d’action dédié.
Bouton de génération d’une nouvelle clé d’API
La génération d’une nouvelle clé d’API s’effectue en 2 étapes :
Etape 1 : l’administrateur défini le libellé de la clé d’API.
Définition du libellé
Etape 2 : l’administrateur copie dans son presse-papier la valeur du token automatiquement généré et affiché par l’application.
Visualisation du token
Pour des questions de sécurité, le token ne peut pas être retrouvé. Si cette valeur n’est pas sauvegardée par l’administrateur dans un espace sécurisé de son choix, ce dernier devra révoquer la clé d’API, générer une nouvelle clé d’API et remplacer l’ancienne par la nouvelle dans les TOUTES les intégrations où elle est utilisée.
A chaque création d’une nouvelle clé d’API, un e-mail est automatiquement envoyée par l’application à tous les administrateurs afin de les informer de cette création.
Révoquer une clé d’API
Afin de supprimer une clé d’API, il suffit de cliquer sur le bouton d’action dédié. L’administrateur sera invité à confirmer son action.
Révoquer une clé d’API peut avoir un impact très important sur les intégrations développées par les clients puisque la révocation d’une clé d’API entraine la coupure totale de l’accès à l’API publique et donc aux données d’easiware.
Révocation d’une clé d’API
A chaque création d’une nouvelle clé d’API, un e-mail est automatiquement envoyé par l’application à tous les administrateurs afin de les informer de cette création.