API REST de Azumuta
Nota: Este es un artículo de carácter altamente técnico. Por ello, le recomendamos involucrar a su departamento de TI al leerlo. Si tiene alguna consulta o petición, póngase en contacto con nosotros a través de support@azumuta.com: estaremos encantados de ayudarle.
Nuestra REST API utiliza códigos de respuesta HTTP y verbos estándar. Al realizar una solicitud GET normal, los datos se devuelven codificados en JSON.
Autenticación
La API de Azumuta utiliza claves API para autenticar las solicitudes. Envíe la clave en el encabezado de la solicitud X-API-Key (recomendado). También puede usar un parámetro de consulta apiKey.
Cree y administre claves en Management → Devices → API. Vea Crear y administrar claves API.
Todas las solicitudes a la API deben realizarse mediante HTTPS. Las llamadas por HTTP sin cifrar fallarán. Las solicitudes a la API sin autenticación también fallarán.
Nota: Sus claves API son información altamente confidencial que nunca debe compartirse con personas ajenas a su empresa, y no deben aparecer en el código del cliente del navegador.
Acceder a la documentación de la API
La REST API de Azumuta está documentada en la documentación integrada en la aplicación:
- Haga clic en el signo de interrogación en la esquina superior derecha de su pantalla (Help).
- Haga clic en API docs.
Esto abre la referencia interactiva en /docs/api en la Azumuta platform. Allí podrá consultar los endpoints de los módulos y complementos de Azumuta (excepto Dashboards).
Cuando esté autenticado, puede probar endpoints en vivo con el botón Try it out y ver el resultado en su Azumuta platform.
Guía de Workspace AI para desarrolladores
Si está desarrollando una integración con un asistente de programación basado en IA, comience con la guía adaptada al workspace en lugar de pegar el documento completo de OpenAPI en su base de conocimientos.
La petición autenticada GET /api/v1/agents-azumuta.md devuelve un archivo Markdown para su workspace (URL base, idiomas y convenciones de la API). Descárguelo desde la introducción de la documentación de API integrada en la aplicación, o solicite esa ruta con su clave API.
La especificación OpenAPI legible por máquina está disponible en /api/v1/spec.json (también requiere su clave API), o a través de la Swagger UI en la documentación de API.
MCP para asistentes de IA (beta)
Funcionalidad beta. El MCP (Model Context Protocol) de Azumuta permite que asistentes de IA llamen a herramientas REST permitidas para su workspace. Está en beta, puede evolucionar y está disponible solo mediante activación voluntaria. Para habilitar MCP o realizar consultas, contacte con support@azumuta.com.
El acceso a MCP requiere el experimento MCP del workspace y una clave API con scopes explícitos. Prefiera la guía de Workspace AI y la documentación de API integrada en la aplicación para las convenciones de endpoints; no pegue el documento completo de OpenAPI en una base de conocimientos compartida.
Llamar a la API desde integraciones del lado del servidor
Llame a la REST API de Azumuta únicamente desde integraciones del lado del servidor. Mantenga la clave API en su servidor o en la capa de integración; no la coloque en navegadores de operarios ni en otro código del lado del cliente.