L'API REST d'Azumuta

Mis à jour

Note : Cet article est technique ; nous vous recommandons d'impliquer une personne disposant des compétences techniques appropriées. Si vous avez des questions, contactez-nous à support@azumuta.com.

Notre REST API utilise les codes de réponse HTTP et les verbes standard. Lors d'une requête GET normale, les données sont renvoyées encodées au format JSON.

Authentification

L'API Azumuta utilise des clés API pour authentifier les requêtes. Vous avez deux options :

Envoyez la clé dans l'en-tête de requête X-API-Key.

Parameter

Utilisez le paramètre de requête apiKey.

Create and manage keys under Management → Devices → API. See Create and manage API keys.

Toutes les requêtes API doivent être effectuées via HTTPS. Les appels en HTTP simple échoueront. Les requêtes API sans authentification échoueront également.

Note : Vos clés API sont des informations sensibles qui ne doivent jamais être partagées en dehors de votre entreprise et ne doivent jamais apparaître dans le code client du navigateur.

Accéder à la documentation de l'API

L'API REST d'Azumuta est documentée dans nos API docs intégrées à l'application :

  1. Cliquez sur le point d'interrogation en haut à droite de votre écran (Help).
  2. Cliquez sur API docs.

Cela ouvre la référence interactive à /docs/api dans la Azumuta platform. Vous pourrez y parcourir les endpoints des modules et add-ons d'Azumuta (sauf Dashboards).

Quand vous êtes authentifié, vous pouvez tester les endpoints en direct avec le bouton Try it out et voir le résultat dans votre Azumuta platform.

docs how to access api documentation

Workspace AI Primer for Developers

Si vous développez une intégration avec un assistant de codage IA, commencez par le guide spécifique à l'espace de travail plutôt que de coller l'intégralité du document OpenAPI dans votre base de connaissances.

La requête authentifiée GET /api/v1/agents-azumuta.md renvoie un fichier Markdown pour votre espace de travail contenant l'URL de base, les langues et les conventions de l'API. Téléchargez-le depuis l'introduction des API docs intégrées à l'application, ou demandez ce chemin avec votre clé API.

La spécification OpenAPI lisible par machine est disponible à /api/v1/spec.json et nécessite également votre clé API, ou via le Swagger UI dans les API docs.

MCP for AI assistants (BETA)

BETA: Azumuta MCP is currently in beta and may still evolve. It is available by opt-in only. To join the beta or ask questions, contact support@azumuta.com.

Le Model Context Protocol (MCP) permet à votre assistant IA préféré de récupérer des données d'espace de travail autorisées via des outils en lecture seule sélectionnés. Il n'expose pas toutes les opérations REST. Suivez Connect your AI assistant to Azumuta pour la configuration, puis consultez Use Azumuta MCP pour des exemples et les limitations.

Appeler l'API depuis des intégrations côté serveur

Appelez l'API REST d'Azumuta uniquement depuis des intégrations côté serveur. Conservez la clé API sur votre serveur ou couche d'intégration — pas dans les navigateurs des opérateurs ni dans du code côté client.

Articles connexes