Remarque : Cet article est hautement technique. Par conséquent, nous vous recommandons d'impliquer votre département informatique lors de sa lecture. Si vous avez des questions ou des demandes, veuillez nous contactez-nous via support@azumuta.com - nous serions heureux de vous aider.
Notre API REST utilise les codes de réponse HTTP et les verbes standard. Lors d'une demande GET normale, les données sont renvoyées sous forme de réponses encodées en JSON.
Authentification
L'API Azumuta utilise des clés API pour authentifier les demandes. Envoyez la clé dans l'en-tête de demande X-API-Key (recommandé). Vous pouvez également utiliser un paramètre de requête apiKey.
Créez et gérez les clés sous Gestion → Appareils → API. Voir Comment faire pour créer et gérer les clés API.
Toutes les demandes d'API doivent être effectuées via HTTPS. Les appels effectués via HTTP simple échoueront. Les demandes d'API sans authentification échoueront également.
Remarque : Vos clés API sont des informations top-secrètes qui ne doivent jamais être partagées avec quiconque en dehors de votre entreprise et ne doivent jamais apparaître dans le code client du navigateur.
Comment faire pour accéder à la documentation de l'API
L'API REST d'Azumuta est documentée dans nos docs API intégrées :
- Cliquez sur le point d'interrogation en haut à droite de votre écran (Aide).
- Cliquez sur Docs API.
Cela ouvre la référence interactive à /docs/api dans la Plateforme Azumuta. Là, vous pouvez parcourir les points de terminaison pour les modules Azumuta et les extensions (sauf les Tableaux de bord).
Lorsque vous êtes authentifié, vous pouvez tester en direct les points de terminaison avec le bouton Essayer et voir le résultat dans votre Plateforme Azumuta.
Amorce de l'IA de l'Espace de travail pour les développeurs
Si vous créez une intégration avec un assistant de codage IA, commencez par l'amorce adaptée à l'espace de travail plutôt que de coller le document OpenAPI complet dans votre base de connaissances.
L'authentification GET /api/v1/agents-azumuta.md renvoie un fichier markdown pour votre espace de travail (URL de base, langues et conventions d'API). Téléchargez-le à partir de l'introduction des docs API intégrées, ou demandez ce chemin avec votre clé API.
La spécification OpenAPI lisible par machine est disponible à /api/v1/spec.json (nécessite également votre clé API), ou via l'interface utilisateur Swagger dans les docs API.
MCP pour les assistants IA (bêta)
Fonctionnalité bêta. Le serveur MCP (Model Context Protocol) d'Azumuta permet aux assistants IA d'appeler les outils REST autorisés pour votre espace de travail. Il est en bêta, peut encore évoluer et n'est disponible que sur opt-in. Pour activer MCP ou poser des questions, contactez support@azumuta.com.
L'accès MCP nécessite l'expérience MCP de l'espace de travail et une clé API avec des portées explicites. Préférez l'amorce de l'IA de l'Espace de travail et les docs API intégrées pour les conventions de points de terminaison ; ne collez pas le document OpenAPI complet dans une base de connaissances partagée.
Appeler l'API à partir des intégrations côté serveur
Appeler l'API REST d'Azumuta à partir des intégrations côté serveur seulement. Conservez la clé API sur votre serveur ou couche d'intégration - pas dans les navigateurs des opérateurs ou autre code côté client.