Gérer les clés API
Les clés API sont utilisées pour établir des sessions sécurisées avec HOPEX, par exemple lors de l'utilisation de GraphQL, ou dans le cadre d'une intégration avec ServiceNow ou Microsoft Teams.
Accéder à la liste des clés API
Les clés API sont affichées sous forme de liste.
Pour accéder à la liste des clés API :
1. Connectez-vous au bureau HOPEX Administration.
2. Dans la barre de navigation, sélectionnez Utilisateurs > Clés API.
La liste des clés API s'affiche.
Générer une clé API
Pour générer une nouvelle clé API :
1. Accédez à la liste des clés API.
2. Dans la barre de menu de la liste, cliquez sur Générer.
L'assistant de génération de clé API apparaît.
3. Saisissez le Nom de la clé API.
4. Sélectionnez la Personne et le Profil concernés.
5. Sélectionnez un Mode de session :
• Multi session (recommandé) : optimisé pour l'utilisation de requêtes GraphQL ou les intégrations avec Microsoft Teams et ServiceNow.
• Mono session : moins performant, consomme davantage de mémoire et peut ralentir les autres utilisateurs.
6. Sélectionnez un Mode de connexion.
• Lecture Ecriture
• Lecture seule
7. Sélectionnez les langues :
• Langue des données : langue d'affichage des données du référentiel.
• Langue de l'interface : langue d'affichage des éléments de l'interface, y compris les messages d'erreur, et les valeurs tabulaires internes ou externes.
8. (Optionnel) Sélectionnez une date d'expiration de la clé API.
9. (Optionnel) Renseignez une description.
10. Cliquez sur OK.
La clé API est générée et peut être copiée.
Elle est ajoutée dans la liste des clés API.
Vous pouvez revisualiser la valeur de la clé ultérieurement.
Visualiser la valeur d'une clé API
Vous pouvez visualiser la valeur secrète d'une clé API.
Pour visualiser la valeur secrète d'une clé API :
1. Accédez à la liste des clés API.
2. Sélectionnez la clé API concernée.
Vous pouvez vous aider de l'outil de filtrage de la liste pour trouver la clé API.3. Dans la barre de menu de la liste, cliquez sur Voir 
.
.La clé API s'affiche et peut être copiée.
Révoquer une clé API
Pour des raisons organisationnelles ou de sécurité, vous pouvez avoir besoin de révoquer une clé API.
Pour révoquer une clé API :
1. Accédez à la liste des clés API.
2. Sélectionnez la clé API concernée.
Vous pouvez vous aider de l'outil de filtrage de la liste pour trouver la clé API.3. Dans la barre de menu de la liste, cliquez sur Révoquer 
.
.La clé API est supprimée et ne peut plus être utilisée.
Renouveler une clé API
Seules les clés API pour lesquelles une date d'expiration a été configurée peuvent être renouvelées.
Pour renouveler une clé API :
1. Accédez à la liste des clés API.
2. Sélectionnez la clé API souhaitée.
Vous pouvez vous aider de l'outil de filtrage (ex. : Date d'expiration de la liste pour trouver la clé API.3. Dans la barre de menu de la liste, cliquez sur Renouveler 
.
.L'assistant de génération de clé API apparaît.
4. Saisissez ou modifiez les informations voulues.
5. Cliquez sur OK.
Une nouvelle clé est créée et apparaît dans la liste des clés API.
Il est important de révoquer l'ancienne clé pour éviter tout usage indésirable et de mettre à jour la nouvelle clé dans toutes les applications ou services qui l'utilisent.