Gestion des clés API

Les clés API sont des identificateurs uniques utilisés pour l'authentification, permettant aux utilisateurs, aux développeurs ou aux programmes d'accéder en toute sécurité à des API. Elles sont essentielles pour suivre et contrôler l'utilisation des API, ce qui permet d'éviter les abus et de garantir la sécurité des communications.

video thumbnail

Utilisation de clés API pour se connecter aux API Qlik Cloud

Vous pouvez utiliser des clés API pour interagir avec la référence d'API REST Qlik. Des outils tels que Postman ou qlik-cli peuvent être utilisés pour l'accès à l'API. Pour plus d'informations, voir Vue d'ensemble des API Qlik et qlik-cli.

Exemple : Utilisation de Postman pour se connecter aux API Qlik

Procédez comme suit :

Lancez Postman.
Définissez la méthode HTTP sur GET.
Saisissez l'URL du point de terminaison de l'API Qlik Cloud.

Pour l'exemple, pour répertorier tous les espaces du client :

https://your-tenant.eu.qlikcloud.com/api/v1/spaces
Dans l'onglet Auth, sélectionnez Jeton de porteur comme Type de Auth.
Saisissez votre clé API dans le champ Jeton.
Cliquez sur Send (Envoyer).

Si la requête aboutit, l'API renvoie une réponse JSON. Dans cet exemple, la réponse inclurait une liste d'espaces.

Activation de clés API dans le client

Ce paramètre est obsolète et sera supprimé dans une prochaine version. Après la suppression, la création de clés API sera contrôlée exclusivement par l'autorisation Gérer les clés API.

Les administrateurs de clients peuvent contrôler si les utilisateurs sont autorisés ou non à générer des clés API dans le client.

Procédez comme suit :

Dans le centre d'activités Administration, accédez à la page Paramètres.
Sélectionnez l'onglet Contrôle de fonction.
Dans Clés API, activez ou désactivez l'option Activer les clés API.

Configuration des paramètres de clé API

Procédez comme suit :

Dans le centre d'activités Administration, accédez à la page Paramètres.
Sélectionnez l'onglet Contrôle de fonction.
Dans la section Clés API, modifiez les paramètres suivants selon les besoins :
- Modifier la date d'expiration maximale du jeton : définissez la période d'expiration des nouveaux jetons API générés. Les clés API existantes conserveront leur valeur d'expiration d'origine. Il n'existe pas de limite supérieure pour cette valeur.
- Modifier le nombre maximal de clés API actives par utilisateur : définissez le nombre de clés API limite qu'un utilisateur peut avoir. Cette limite ne s'applique qu'aux nouvelles clés. Si la limite est atteinte, les utilisateurs ne pourront pas créer de clés supplémentaires. La valeur maximale est de 1 000.

Vous devrez peut-être actualiser votre navigateur pour voir les modifications reflétées dans la section Clés API de la page de vos paramètres personnels.

Génération et gestion de clés API

Génération de clés API

Pour générer de nouvelles clés API, vous devez avoir un rôle personnalisé avec l'autorisation Gérer les clés API, ou l'autorisation doit être activée dans les paramètres Utilisateur par défaut.

Procédez comme suit :

Cliquez sur l'icône de votre profil d'utilisateur et sélectionnez Paramètres.
Accédez à la section Clés API et cliquez sur Générer une nouvelle clé.
Fournissez une description et définissez une date d'expiration pour la clé API.
Cliquez sur Générer pour créer la clé.
Copiez la clé API générée et stockez-la en lieu sûr. Notez que la clé ne peut pas être récupérée ultérieurement.

Modification de clés API

Vous pouvez modifier le Nom d'une clé API après sa création.

Suppression de clés API

La suppression de clés API est permanente et irréversible. Assurez-vous que cette action ne perturbe pas les processus et intégrations en cours qui s'appuient sur la clé.

Vous pouvez :

Cliquez sur l'icône de votre profil d'utilisateur et sélectionnez Paramètres.
Accédez à la section Clés API.
Cliquez sur près de la clé API à supprimer et sélectionnez Supprimer.
Pour supprimer toutes les clés, cliquez sur Supprimer tout au-dessus de la liste de clés.

Surveillance et révocation de clés API

Vous pouvez afficher toutes les clés API associées à votre client dans la section Clés API du centre d'activités Administration. Vous pouvez rechercher des clés par leur nom, leur ID ou leur propriétaire.

Statuts des clés API

Les clés API peuvent avoir les statuts suivants :

Active : la clé 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.

Révocation de clés API

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

La révocation d'une clé API la désactive immédiatement, affectant les processus ou intégrations en cours s'appuyant sur elle. La révocation est irréversible ; une clé API révoquée ne peut pas être réactivée.

Vous pouvez :

Dans le centre d'activités Administration, accédez à Événements.
Recherchez toute activité suspecte telle qu'une utilisation excessive d'une clé API spécifique.
Cliquez sur près de l'événement pour développer ses détails et copiez l'ID de la clé API.
Accédez à la section Clés API et recherchez la clé API à l'aide de son ID.
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.
Pour révoquer plusieurs clés API, sélectionnez-les dans le tableau et cliquez sur Révoquer dans le coin supérieur droit.

Meilleures pratiques pour la gestion des clés API

Gardez les clés confidentielles : stockez les clés API en lieu sûr et évitez de les exposer dans des référentiels de codes publics.
Régénérez-les régulièrement : régénérez périodiquement vos clés API pour renforcer la sécurité.
Surveillez leur utilisation : vérifiez régulièrement les activités des clés API afin d'identifier tout comportement suspect.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici