Remarque : Cet article est très technique. Par conséquent, nous vous recommandons de faire intervenir votre département informatique lors de sa lecture. Si vous avez des questions ou des demandes, veuillez nous contactez-nous à l'adresse support@azumuta.com - nous serions heureux de vous aider.
Les clés API authentifient les demandes adressées à l'API REST d'Azumuta. Chaque clé appartient à un Appareil API dans votre Espace de travail. Vous gérez ces appareils sur la page Appareils API.
Comment créer une clé API
- Allez à Gestion → Appareils → onglet API. Le titre de la page est Appareils API.
- Cliquez sur Ajouter un appareil.
- Entrez un Nom, définissez Type sur Api Device, puis cliquez sur Ajouter.
Azumuta crée l'appareil et génère une clé API pour celui-ci.
Pour plus d'informations sur les pages Appareils en général, consultez Comment faire pour voir la liste des appareils connectés à votre Espace de travail.
Comment copier une clé API
Vous pouvez copier une clé de l'une de ces deux façons :
- Sur la liste Appareils API, ouvrez le menu de ligne de l'appareil et cliquez sur Copier la clé API. Une barre de notification affiche Copié.
- Ou cliquez sur Modifier le périphérique, trouvez Attributs de l'API, puis utilisez l'icône de copie à côté du champ Clé.
Comment authentifier les demandes API
Envoyez la clé dans l'en-tête de demande X-API-Key. C'est la méthode recommandée.
Vous pouvez également transmettre la clé en tant que apiKey paramètre de requête. Préférez l'en-tête quand vous le pouvez.
Toutes les demandes API doivent utiliser HTTPS. Les demandes sur HTTP simple échouent. Les demandes sans clé valide échouent également.
Important : Ne mettez jamais une clé API dans le code client du navigateur, les référentiels publics ou tout endroit en dehors de votre entreprise. Traitez les clés comme des identifiants secrets réservés aux intégrations côté serveur uniquement.
Portée de l'environnement
Les clés API sont délimitées par l'environnement. Une clé créée sur votre hôte sandbox fonctionne seulement contre cet environnement sandbox. Une clé de production fonctionne seulement contre la production. L'utilisation d'une clé sandbox contre la production (ou l'inverse) retourne une erreur d'authentification.
Optionnel : Scopes API
Si l'expérience des scopes API est activée pour votre Espace de travail, vous pouvez restreindre ce qu'une clé peut faire. Ouvrez Modifier le périphérique → Sécurité, puis configurez Scopes API. Quand cette option n'est non disponible pour votre Espace de travail, la clé dispose de l'accès par défaut pour un Appareil API.