Créer une clé d'API

Pour travailler de manière programmatique, vous pouvez créer une clé API afin de gérer votre compte, vos ressources DNS, vos configurations de pilotage du trafic, etc. à l'aide de l'API.

La plateforme IBM® NS1 Connect® est construite sur la base d'une architecture API-first, ce qui signifie que presque tout ce que vous pouvez faire dans le portail peut être fait via une API. En outre, les clés API sont utilisées pour les intégrations avec la plateforme NS1 Connect .

Attention : Pour garantir la sécurité de votre compte NS1 Connect , ne partagez pas les secrets de la clé API entre plusieurs utilisateurs ou intégrations tierces. Vous pouvez gérer les clés API en supprimant les clés API anciennes ou redondantes si elles ne sont plus utilisées, et en limitant les autorisations pour chaque clé API à ce qui est nécessaire pour l'utilisation prévue.

Suivez les instructions suivantes pour créer une nouvelle clé API :

  1. Cliquez sur l'icône Paramètres utilisateur et sélectionnez Utilisateur et équipes.
  2. Cliquez sur l'onglet Clés API.
  3. Cliquez sur Ajouter une clé.
  4. Dans App Name (Nom de l'application ), saisissez un nom pour la clé API à des fins de référence interne.
  5. Sélectionnez les autorisations appropriées pour la clé API. Reportez-vous à la section Autorisations du compte pour plus de détails sur chaque option d'autorisation.
  6. Sous Accès aux ressources DNS, indiquez si la clé API doit pouvoir gérer ou consulter les zones DNS associées à votre compte.
  7. Identifiez les zones et les enregistrements auxquels la clé API doit avoir accès en effectuant l'une des opérations suivantes :
    • Cochez la case Autoriser par défaut pour permettre à la clé API d'accéder à toutes les zones. Si, toutefois, il existe des zones et des enregistrements auxquels la clé API n'est pas autorisée à accéder, sélectionnez-les dans Zones et enregistrements refusés.
    • Décochez la case Autoriser par défaut pour refuser l'accès à toutes les zones. Si, toutefois, il existe des zones et des enregistrements auxquels la clé API est autorisée à accéder, sélectionnez-les dans Zones et enregistrements autorisés.
  8. Sous IP allow list, pour chaque adresse IPv4 ou CIDR à partir de laquelle la clé API peut accéder à votre compte, procédez comme suit :
    1. Saisissez l'adresse IPv4 ou le CIDR.
    2. Cliquez sur Ajouter.
  9. En option, sélectionnez Appliquer exclusivement cette liste d'autorisations IP pour ignorer les autres listes d'autorisations IP appliquées au niveau global ou au niveau de l'équipe. Si cette option est sélectionnée, la clé API ne peut accéder au compte qu'à partir d'une adresse IP spécifiée ici.
  10. Cliquez sur Enregistrer la clé API. La nouvelle clé API apparaît dans la liste avec une option temporaire pour afficher/masquer le secret de la clé API.
    Avertissement : Ne quittez pas la page avant d'avoir enregistré le secret de la clé API. Vous ne pourrez pas récupérer le secret de la clé API après avoir quitté la page.
  11. Cliquez sur l'icône Afficher pour voir la clé secrète de l'API.

  12. Enregistrez la clé API dans un gestionnaire de mots de passe sécurisé ou une valeur de clé pour référence ultérieure.