Génération de clés d'API pour l'authentification

Avec une clé API, vous pouvez vous authentifier automatiquement auprès de Data Fabric à partir d'un script ou d'une application. Vos clés d'API sont associées à vos données d'identification et vous sont propres. Avec les clés d'API, vous pouvez vous authentifier sans entrer votre mot de passe.

Vous pouvez générer :

Vous pouvez également générer une nouvelle clé API de manière programmatique en utilisant le point de terminaison Get API key . Cependant, ce point d'accès nécessite un jeton d'autorisation ZenApiKey ou un jeton Bearer et n'est pas recommandé.

Votre clé API de plateforme permet aux scripts et aux applications d'accéder à tout ce à quoi vous pouvez normalement accéder lorsque vous vous connectez au Data Fabric client web. Une clé d'API d'instance active uniquement l'accès à l'instance spécifique à partir de laquelle elle est générée.

Lorsque vous générez une clé d'API, tenez compte des facteurs suivants :
Quel est le niveau d'accès requis ?
En tant que meilleure pratique de sécurité, il est recommandé d'accorder l'accès minimal requis au script ou à l'application. Par exemple, si un script doit interagir uniquement avec une instance de service spécifique, générez une clé d'API pour cette instance de service.
Quel type de clé puis-je générer ?
Certains services ne prennent pas en charge les clés d'API au niveau de l'instance. Si vous ne pouvez pas générer de clé d'API propre au service, vous devez utiliser la clé d'API de la plateforme.
Important : veillez à conserver vos clés API dans un endroit sûr. Si vous perdez une clé d'API, vous devez créer une nouvelle clé et mettre à jour les scripts ou les applications dans lesquels la clé est utilisée.

Clé d'API de plateforme

Avec une clé API de plateforme, vous pouvez accéder à tout ce à quoi vous pourriez normalement accéder lorsque vous vous connectez au Data Fabric client web.

Pour générer une clé d'API de plateforme :

  1. Connectez-vous au client Web.
  2. Dans la barre d'outils, cliquez sur votre avatar.
  3. Cliquez sur Profil et paramètres.
  4. Cliquez sur Clé API > Générer une nouvelle clé.
  5. Cliquez sur Générer.
  6. Cliquez sur Copier et sauvegardez votre clé à un emplacement sécurisé. Vous ne pouvez pas récupérer cette clé si vous la perdez.

Si vous perdez votre clé d'API, répétez les étapes précédentes pour générer une nouvelle clé d'API. Votre ancienne clé d'API n'est alors plus valide et les applications et les scripts ne peuvent plus s'authentifier sur la plateforme tant que vous n'avez pas indiqué votre nouvelle clé d'API.

Si vous pensez que votre clé d'API est compromise :

  1. Connectez-vous au client Web.
  2. Dans la barre d'outils, cliquez sur votre avatar.
  3. Cliquez sur Profil et paramètres.
  4. Cliquez sur Clé API > Révoquer la clé actuelle.
  5. Cliquez sur Révoquer.

Les applications et les scripts qui utilisent la clé ne pourront pas s'authentifier sur la plateforme.

Clés d'API d'instance

Si vous avez accès à une instance spécifique d'un service, vous pouvez générer une clé d'API pour accéder uniquement à cette instance de service.

Restriction : Cette fonction peut ne pas être disponible pour tous les services.

Pour générer une clé d'API d'instance :

  1. Connectez-vous au client Web.
  2. Dans le menu de navigation, sélectionnez Services > Instances.
  3. Cliquez sur le nom de l'instance pour laquelle générer une clé d'API.
  4. Cliquez sur Instance API key > Generate API key.
  5. Cliquez sur Générer.
  6. Cliquez sur Copier et sauvegardez votre clé à un emplacement sécurisé. Vous ne pouvez pas récupérer cette clé si vous la perdez.

Si vous perdez votre clé d'API, répétez les étapes précédentes pour générer une nouvelle clé d'API. Votre ancienne clé d'API n'est alors plus valide et les applications et les scripts ne peuvent plus s'authentifier dans l'instance tant que vous n'avez pas indiqué votre nouvelle clé d'API.

Si vous pensez que votre clé d'API est compromise :

  1. Connectez-vous au client Web.
  2. Dans le menu de navigation, sélectionnez Services > Instances.
  3. Cliquez sur le nom de l'instance pour laquelle révoquer votre clé d'API en cours.
  4. Cliquez sur Clé API d'instance > Révoquer la clé API.
  5. Cliquez sur Révoquer.

Les applications et les scripts qui utilisent la clé ne pourront pas s'authentifier dans l'instance.

Jetons d'API

Pour générer un jeton d'autorisation API, utilisez l'une des méthodes suivantes.