Comment créer et gérer des clés API

Mis à jour

Remarque : Il s'agit d'un article très technique. Nous vous recommandons donc d'associer votre service informatique lors de la lecture. Si vous avez des questions ou des demandes, veuillez nous contacter via support@azumuta.com — nous serons heureux de vous aider.

Les clés API authentifient les requêtes vers l'API REST d'Azumuta. Chaque clé appartient à un API device dans votre espace de travail. Vous gérez ces appareils sur la page API Devices.

Comment créer une clé API

  1. Allez dans ManagementDevices → onglet API. Le titre de la page est API Devices.
  2. Cliquez sur Add device.
  3. Saisissez un Name, réglez Type sur Api Device, puis cliquez sur Add.

Azumuta crée l'appareil et génère une clé API pour celui-ci.

Pour plus d'informations sur les pages Devices en général, consultez Comment voir la liste des appareils connectés à votre espace de travail.

Comment copier une clé API

Vous pouvez copier une clé de l'une des manières suivantes :

  1. Dans la liste API Devices, ouvrez le menu de la ligne correspondant à l'appareil et cliquez sur Copy API key. Un snackbar affiche Copied.
  2. Ou cliquez sur Edit device, trouvez API attributes, puis utilisez l'icône de copie à côté du champ API key.

Comment authentifier les requêtes API

Envoyez la clé dans l'en-tête de requête X-API-Key. C'est la méthode recommandée.

Vous pouvez aussi transmettre la clé en paramètre de requête apiKey. Préférez l'en-tête lorsque possible.

Toutes les requêtes API doivent utiliser HTTPS. Les requêtes via HTTP simple échouent. Les requêtes sans clé valide échouent également.

Important : Ne placez jamais une clé API dans du code côté client (navigateur), dans des dépôts publics ou dans tout emplacement accessible hors de votre entreprise. Considérez les clés comme des identifiants secrets destinés uniquement aux intégrations côté serveur.

Portée de l'environnement

Les clés API sont limitées à un environnement. Une clé créée sur votre hôte sandbox ne fonctionne que dans cet environnement sandbox. Une clé de production ne fonctionne que sur l'environnement de production. L'utilisation d'une clé sandbox contre la production (ou inversement) renvoie une erreur d'authentification.

Optionnel : API Scopes

Si l'expérience API scopes est activée pour votre espace de travail, vous pouvez restreindre les actions autorisées pour une clé. Ouvrez Edit deviceSecurity, puis configurez API scopes. Si cette option n'est pas disponible pour votre espace de travail, la clé dispose de l'accès par défaut pour un API device.