Accéder au contenu principal

Gestion des clés API

Une clé API sert d'identifiant unique pour authentifier un utilisateur, un développeur ou un programme appelant sur API. Les clés API sont généralement utilisées pour suivre et contrôler l'utilisation de l'interface afin d'éviter tout abus de API.

Présentation des clés API

Par défaut, les clés API sont désactivées dans Console de gestion. Pour activer les clés API, accédez à la section Paramètres. Un administrateur de clients peut révoquer des clés API et modifier les paramètres de clé API. Toutefois, pour générer ou supprimer des clés API, vous devez posséder le rôle de développeur. Un administrateur de client attribue le rôle de développeur à un utilisateur. Si vous êtes un administrateur de client, vous pouvez vous attribuer le rôle de développeur.

La API table de clés affiche les informations suivantes relatives aux API clés : nom, ID, propriétaire, dernière mise à jour, date de création, date d'expiration et statut. Utilisez le champ de recherche pour effectuer une recherche dans les trois premiers champs : Nom de la clé, ID de la cléet propriétaire.

API états de clé

Les clés API peuvent avoir les états suivants :

  • Active : la clé API est utilisée.
  • A expiré : la date d'expiration est dépassée.
  • Révoquée : la API clé a été révoquée et ne peut plus être utilisée.

En qualité d’administrateur, vous pouvez contrôler les activités de clé API enregistrées dans la section Événements de Console de gestion. Si des activités suspectes sont détectées, par exemple si une clé API est utilisée de manière inhabituelle, vous pouvez révoquer la clé API. Ouvrez la liste détaillée en cliquant sur la flèche située à droite dans la table et copiez l'ID de la clé API. Vous pouvez rechercher l'ID dans la section de clés API pour trouver la clé API à révoquer.

Pour révoquer une seule API clé, cliquez sur le bouton ... situé à droite et sélectionnez Révoquer. Seules les clés possédant l'état Active peuvent être révoquées. Pour révoquer plusieurs clés, cochez les cases à gauche des clés à révoquer et cliquez sur Révoquer dans le coin supérieur droit. La révocation est définitive. Une clé API révoquée ne peut pas être réactivée.

Outre la révocation, vous disposez de l'option de suppression. Vous pouvez supprimer une clé APId'un hub mais pas de Console de gestion.

Activation de clés API dans le client

Le paramètre Activer les clés API est activé dans Console de gestion sur la page Paramètres. Par défaut, les clés API sont désactivées dans Console de gestion.

Propriétés des clés API
Propriété Description
Activer les APIclés

Ce switch active ou désactive toutes les clés API dans le client. Seul l'administrateur du client peut activer les API clés.

Modifier la date d'expiration maximale du jeton

En modifiant la valeur d'expiration du jeton, tous les nouveaux jetons auront la nouvelle valeur d'expiration. Les API déjà existantes ne seront pas affectées par la modification, elles continueront d'avoir la même valeur d'expiration que précédemment.

Modifier le nombre maximum de clés API par utilisateur

Ce paramètre ne touche que les nouvelles API clés. Si le nombre maximum de clés est dépassé API, la création est impossible.

Procédez comme suit :

  1. Dans Console de gestion, accédez à la page Paramètres.
  2. Sous la section Clés API, activez le bouton Activer les clés API.
  3. Le cas échéant, modifiez les paramètres Changer l'expiration de jeton maximum et Changer les clés API maximum par utilisateur.

Génération d'une API clé à partir du hub

Vous pouvez générer API des clés à partir du hub. Avant de débuter, assurez-vous de respecter les trois conditions suivantes :

  • Vous utilisez une licence. Pour générer une clé API, il est nécessaire de posséder une licence.

  • Le paramètre Activer API les clés est activé dans Console de gestion.
  • L'administrateur du client vous a attribué le rôle de développeur.

Procédez comme suit :

  1. Connectez-vous à votre client, par exemple https://<nomclient>.com.

  2. Cliquez sur votre profil dans le coin supérieur droit et sélectionnez Paramètres du profil.

  3. Sélectionnez des clés API.

  4. Cliquez sur Générer une nouvelle clé.

  5. Saisissez une description de clé API et sélectionnez la date d'expiration de la clé API.

  6. Cliquez sur Générer.

    Une clé API est générée.

  7. Copiez la clé API et conservez-la dans un endroit sécurisé.

Après sa création, vous pouvez modifier le nom de la clé API. Vous pouvez également la supprimer.