REST API de Azumuta
Nota: Este artículo es técnico, por lo que recomendamos involucrar a alguien con la experiencia técnica adecuada. Si tiene alguna pregunta, contáctenos en support@azumuta.com.
Nuestra API REST usa códigos de respuesta HTTP y verbos estándar. Al realizar una solicitud GET normal, los datos se devuelven como respuestas codificadas en JSON.
Autenticación
La API de Azumuta utiliza claves API para autenticar las solicitudes. Tiene dos opciones:
Encabezado (recomendado)
Envíe la clave en el encabezado de la solicitud X-API-Key.
Parámetro
Use el parámetro de consulta apiKey.
Cree y gestione las claves en Management → Devices → API. Vea Create and manage API keys.
Todas las solicitudes a la API deben realizarse mediante HTTPS. Las llamadas realizadas por HTTP simple fallarán. Las solicitudes a la API sin autenticación también fallarán.
Nota: Sus claves API son información sensible que nunca debe compartirse con personas fuera de su empresa y nunca deben aparecer en código cliente ejecutado en el navegador.
Acceder a la documentación de la API
La API REST de Azumuta está documentada en los API docs 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 para módulos y add-ons 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.
Workspace AI Primer for Developers
Si está desarrollando una integración con un asistente de codificación IA, comience con la guía adaptada al Workspace en lugar de pegar el documento OpenAPI completo en su base de conocimiento.
La petición autenticada GET /api/v1/agents-azumuta.md devuelve un archivo Markdown para su workspace que incluye la URL base, los idiomas y las convenciones de la API. Descárguelo desde la introducción de los API docs en la aplicación o solicite esa ruta con su clave API.
La especificación OpenAPI legible por máquinas está disponible en /api/v1/spec.json y también requiere su clave API, o a través del Swagger UI en los API docs.
MCP para asistentes de IA (BETA)
BETA: Azumuta MCP está actualmente en beta y puede seguir evolucionando. Está disponible solo mediante opt-in. Para unirse a la beta o hacer preguntas, contacte a support@azumuta.com.
Model Context Protocol (MCP) permite que su asistente de IA preferido recupere datos permitidos del workspace a través de herramientas de solo lectura seleccionadas. No expone todas las operaciones REST. Siga Connect your AI assistant to Azumuta para la configuración, y luego consulte Use Azumuta MCP para ejemplos y limitaciones.
Llamar a la API desde integraciones del lado del servidor
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.