Visión general de la API

La plataforma Mirox expone una API REST para que puedas integrar datos de planta, automatización e informes en tus propios sistemas y flujos de trabajo. Todo lo que hace la interfaz web está construido sobre los mismos endpoints públicos, así que puedes manejar la plataforma de forma programática.

Documentación interactiva

La especificación completa de la API se genera en vivo a partir de la plataforma en ejecución y está disponible en dos vistas interactivas:

  • Swagger UI en /docs — una referencia interactiva con un constructor de peticiones integrado para probar llamadas directamente en el navegador.
  • ReDoc en /redoc — la misma especificación en un diseño optimizado para la lectura y la navegación.

Ambas vistas te permiten explorar cada endpoint disponible, sus parámetros, el cuerpo de la petición y el formato de la respuesta. Son la referencia autorizada y siempre actualizada de lo que puede hacer la API.

Cómo está organizada la API

Los endpoints de la API se agrupan según aquello sobre lo que actúan, y cada ruta está versionada (por ejemplo /v1/...). Las áreas comunes incluyen:

  • Plantas, portfolios y componentes — consulta y gestiona tus emplazamientos monitorizados y su estructura.
  • Métricas y exportación de datos — exporta cualquier métrica como serie temporal, en CSV o, con format=json, en JSON, y define métricas propias.
  • Eventos, tickets e informes — recupera señales detectadas por la máquina, el trabajo de seguimiento humano y los informes generados.
  • Organización, cooperaciones y acceso — gestiona miembros, compartición y tokens de integración.

El acceso a cada endpoint se rige por tu rol y tus permisos. Una llamada solo devuelve las plantas y los datos que tienes derecho a ver, de modo que la API aplica las mismas reglas de acceso que la interfaz.

No todo aparece listado en /docs

Algunos grupos de rutas se ocultan intencionadamente de la especificación publicada, por lo que no aparecerán en /docs ni en /redoc aunque funcionen:

  • Endpoints administrativos — funciones de administración de la plataforma reservadas al personal de Mirox.
  • Rutas de asignación de dispositivos (/v1/device).

Si necesitas integrarte con alguna de ellas, contacta con el soporte de Mirox para obtener orientación.

Datos de series temporales

Para datos de series temporales, usa la API de Metric Export. Exporta todas las métricas de la colección —niveles de planta, componente, sensor, aerogenerador y batería, y las métricas de tu organización— con pasos de 1 minuto a un año. Una solicitud GET responde CSV; format=json responde JSON.

Métricas de organización (MetricsQL)

Las métricas definidas en Métricas tienen su propio grupo de rutas, /v1/report/metric: listar, leer, crear, actualizar y eliminar una métrica, POST /v1/report/metric/validate para comprobar una expresión, POST /v1/report/metric/preview para ejecutarla contra una planta y GET /v1/report/metric/building-blocks para las series y los valores configurados que una expresión puede leer. Estas métricas alimentan por igual los informes y Metric Export. Las fórmulas MiroxQL son las columnas calculadas de la exportación heredada; sus rutas siguen disponibles.

Primeros pasos

Para llamar a la API te autenticas con un token de API asignado a un grupo de permisos. Consulta la guía de Tokens de API para saber cómo crear, asignar y rotar tokens, y luego úsalos para hacer peticiones.

Abrir en Mirox

Crea y gestiona tus tokens en Perfil — abre el menú de perfil (arriba a la derecha) ▸ Perfil y usa la sección de tokens de API.

Para obtener código de integración ejecutable y de extremo a extremo, consulta el ejemplo trabajado Generador de informes externo.

Funciones relacionadas