Créez et gérez des clés API
Note : Il s'agit d'un article hautement technique. Nous vous recommandons donc d'impliquer votre service informatique lors de sa lecture. Pour toute question ou demande, contactez-nous via support@azumuta.com — nous serons ravis de vous aider.
Les clés API authentifient les requêtes vers l'API REST d'Azumuta. Chaque clé appartient à un API device de votre espace de travail. Vous gérez ces devices depuis la page API Devices.
Créer une clé API
- Accédez à Management → Devices → onglet API. Le titre de la page est API Devices.
- Cliquez sur le plus jaune → Add device.
- 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 en savoir plus sur les pages Devices en général, consultez Voir la liste des devices connectés à votre espace de travail.
Copier une clé API
Vous pouvez copier une clé de l'une des manières suivantes :
- Dans la liste API Devices, ouvrez le menu de la ligne du 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.
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 passer la clé en 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 placez jamais une clé API dans le code client du navigateur, dans des dépôts publics, ni dans tout emplacement accessible en dehors 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 liées à un environnement. Une clé créée sur votre instance sandbox ne fonctionne que dans cet environnement sandbox. Une clé de production ne fonctionne que contre 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 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.