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.

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 sur qlik.dev. 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 :

1. Lancez Postman.

2. Définissez la méthode HTTP sur GET.

3. 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

4. Dans l'onglet Auth, sélectionnez Jeton de porteur comme Type de Auth.

5. Saisissez votre clé API dans le champ Jeton.

6. Cliquez sur 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

Par défaut, la génération de clés API est désactivée. Les administrateurs de clients doivent activer les clés API dans le client pour permettre aux utilisateurs de les générer.

Procédez comme suit :

1. Dans le centre d'activités Administration, accédez à Paramètres.
2. Sous Clés API, sélectionnez Activer les clés API.

3. Modifiez les paramètres suivants selon les besoins :

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

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

4. Pour commencer à générer des clés API, cliquez sur Générer une nouvelle clé. Vous serez redirigé vers la section Clés API de votre profil d'utilisateur.

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 être titulaire du rôle Développeur. Les administrateurs de clients peuvent affecter ce rôle à des utilisateurs.

Procédez comme suit :

1. Cliquez sur l'icône de votre profil d'utilisateur et sélectionnez Paramètres du profil.

2. Accédez à la section Clés API et cliquez sur Générer une nouvelle clé.

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

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

5. 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.