Créer et gérer des clés API

Mis à jour

Remarque : Cet article est technique, nous vous recommandons de faire intervenir quelqu'un disposant des compétences techniques appropriées. Si vous avez des questions, contactez-nous à support@azumuta.com.

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

Create an API key

  1. Accédez à Management → Devices → onglet API. Le titre de la page est API Devices.
  2. Cliquez sur le plus jaune → Add device.
  3. Saisissez un Name, définissez Type sur Api Device, puis cliquez sur Add.

Azumuta crée le device et génère une clé API pour celui-ci.

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

Copy an API key

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

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

Authenticate API requests

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

Vous pouvez également transmettre la clé en tant que paramètre de requête apiKey. Préférez l'en-tête quand c'est possible.

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

Important : Ne mettez jamais une clé API dans le code client du navigateur, dans des dépôts publics ou dans tout emplacement accessible en dehors de votre entreprise. Considérez les clés comme des identifiants secrets réservés aux intégrations côté serveur.

Environment Scope

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

Optional: API Scopes

Si l'expérience API scopes est activée pour votre espace de travail, vous pouvez restreindre ce qu'une clé peut faire. Ouvrez Edit device → Security, puis configurez API scopes. Lorsque 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.

Sur cette page