API REST de Azumuta
Nota: Este es un artículo altamente técnico. Por ello, le recomendamos implicar a su departamento de TI al leerlo. Si tiene alguna consulta o petición, por favor contáctenos a través de support@azumuta.com - estaremos encantados de ayudarle.
Nuestra REST API utiliza códigos de respuesta HTTP estándar y verbos. Al realizar una petición GET normal, los datos se devuelven en respuestas codificadas en JSON.
Authentication
La API de Azumuta utiliza claves API para autenticar las solicitudes. Envíe la clave en la cabecera de la solicitud X-API-Key (recomendado). También puede usar un parámetro de consulta apiKey.
Cree y gestione claves en Management → Devices → API. Vea How to Create and Manage API Keys.
Todas las solicitudes a la API deben realizarse a través de HTTPS. Las llamadas realizadas 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 código cliente ejecutado en el navegador.
How to Access API Documentation
La REST API de Azumuta está documentada en nuestra documentación de API dentro de 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.
Se abrirá la referencia interactiva en /docs/api en la Azumuta Platform. Allí puede explorar endpoints de los módulos y complementos de Azumuta (excepto Dashboards).
Cuando esté autenticado, puede probar los endpoints en vivo con el botón Try it out y ver el resultado en su Azumuta Platform.
Workspace AI Primer for Developers
Si está creando una integración con un asistente de codificación IA, comience con el primer adaptado al espacio de trabajo en lugar de pegar el documento OpenAPI completo en su base de conocimiento.
Una petición autenticada GET /api/v1/agents-azumuta.md devuelve un archivo Markdown para su espacio de trabajo (URL base, idiomas y convenciones de la API). Descárguelo desde la introducción de la documentación de la API 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 mediante la interfaz Swagger UI en la documentación de la API.
MCP for AI assistants (beta)
Funcionalidad beta. El servidor MCP (Model Context Protocol) de Azumuta permite a los asistentes de IA invocar herramientas REST permitidas para su espacio de trabajo. Está en beta, puede seguir evolucionando y está disponible solo mediante activación (opt-in). Para habilitar MCP o realizar consultas, contacte con support@azumuta.com.
El acceso a MCP requiere el experimento MCP del espacio de trabajo y una clave API con permisos explícitos. Prefiera el workspace AI primer y la documentación de la API en la aplicación para las convenciones de los endpoints; no pegue el documento OpenAPI completo en una base de conocimiento compartida.
Call the API from Server-Side Integrations
Llame a la Azumuta REST API únicamente desde integraciones del lado del servidor. Mantenga la clave API en su servidor o en la capa de integración —no en los navegadores de los operarios ni en otro código del lado del cliente.