Gestion des clés API

Les clés API servent d'identificateurs uniques pour l'authentification, permettant aux utilisateurs, aux développeurs ou aux programmes d'accéder en toute sécurité à une API. Les clés API sont généralement utilisées pour suivre et contrôler l'utilisation de l'API afin d'éviter tout abus.

Présentation des clés API

Dans la section Clés API de la Console de gestion, vous pouvez afficher toutes les clés API associées à votre client. Vous pouvez rechercher des clés par leur nom, leur ID ou leur propriétaire.

Les clés API peuvent avoir les statuts suivants :

• Active : l'API est actuellement utilisée.
• Expirée : la date d'expiration a été atteinte.
• Révoquée : la clé API a été révoquée et ne peut plus être utilisée.

Les administrateurs de clients peuvent activer la génération de clés API et surveiller et révoquer des clés API. Pour pouvoir générer, modifier ou supprimer des clés API, il convient d'être titulaire du rôle Developer. Les administrateurs de clients peuvent affecter ce rôle à des utilisateurs, y compris à eux-mêmes.

Activation de clés API dans le client

Par défaut, les clés API sont désactivées. Les administrateurs de clients peuvent activer des clés API au sein du client.

Procédez comme suit :

1. Dans la Console de gestion, accédez à Paramètres.
2. Recherchez la sectionClés API et sélectionnez Activer les clés API.
3. Si nécessaire, modifiez les paramètres suivants :

   • Modifier la date d'expiration maximale du jeton : modifie la date d'expiration des nouveaux jetons générés. Les clés API existantes conservent leur valeur d'expiration d'origine. Il n'existe pas de limite maximale pour cette valeur.

     Note InformationsVous devrez peut-être actualiser votre navigateur pour voir les modifications apportées à cette valeur reflétées dans la section Clés API de la page de votre profil d'utilisateur.
   • Modifier le nombre maximal de clés API actives par utilisateur : ce paramètre affecte uniquement les nouvelles clés API. Si la limite est atteinte, la création de nouvelles clés API sera refusée. La valeur maximale est de 1 000.

4. Pour commencer à générer des clés API, cliquez sur Générer une nouvelle clé. Cette opération vous redirigera vers la section Clés API de la page de votre profil d'utilisateur, sur laquelle vous pourrez créer de nouvelles clés.

Génération de clés API

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

• Vous disposez d'une licence active.

• L'option Activer les clés API est activée dans la Console de gestion.
• Vous disposez du rôle Developer.

Procédez comme suit :

1. Cliquez sur l'icône de votre profil d'utilisateur dans le coin supérieur droit et sélectionnez Paramètres du profil.

2. Dans la section Clés API, cliquez sur Générer une nouvelle clé.

3. Fournissez une description et une date d'expiration pour la clé API.

4. Cliquez sur Générer pour créer la clé.

5. Copiez immédiatement la clé API générée et stockez-la en toute sécurité. La clé ne peut pas être récupérée ultérieurement.

Après sa création, vous pouvez modifier le nom de la clé API ou la supprimer, si nécessaire.

Avec votre clé API, vous pouvez explorer la référence API REST sur qlik.dev via des outils tels que Postman ou installer qlik-cli pour accéder aux fonctionnalités Qlik directement depuis la ligne de commande. Pour plus d'informations, voir Vue d'ensemble des API Qlik et qlik-cli.

Surveillance et révocation de clés API

En tant qu'administrateur de clients, il est essentiel que vous surveilliez les activités des clés API pour des raisons de sécurité. En cas de détection d'activités suspectes, vous pouvez révoquer la clé API.

N'oubliez pas que la révocation d'une clé API la désactivera immédiatement, ce qui affectera les processus ou intégrations en cours s'appuyant sur elle. La révocation est irréversible et une clé API révoquée ne peut pas être réactivée.

Procédez comme suit :

1. Dans la Console de gestion, accédez à la section Événements.

2. Recherchez toute activité suspecte telle qu'une utilisation excessive d'une clé API spécifique.

3. Cliquez sur près de l'événement pour développer ses détails et copiez l'ID de la clé API.

4. Accédez à la section Clés API et recherchez la clé API à l'aide de son ID.

5. Cliquez sur près de la clé et sélectionnez Révoquer. Vous pouvez révoquer uniquement les clés dont le statut est Actif.

6. Pour révoquer plusieurs clés API, sélectionnez-les dans le tableau et cliquez sur Révoquer dans le coin supérieur droit.

Suppression de clés API

La suppression de clés API supprime définitivement ces clés du système. La suppression d'une clé API est irréversible et supprimera immédiatement ses privilèges d'accès. Assurez-vous que cette action ne perturbe pas les processus et intégrations en cours qui s'appuient sur la clé.

Pour pouvoir supprimer des clés API, vous devez être titulaire du rôle Développeur.

Procédez comme suit :

1. Cliquez sur l'icône de votre profil d'utilisateur dans le coin supérieur droit et sélectionnez Paramètres du profil.

2. Sélectionnez la section Clés API.

3. Cliquez sur près de la clé API à supprimer et sélectionnez Supprimer.

4. Pour supprimer toutes les clés, cliquez sur Supprimer tout au-dessus de la liste de clés API.