Visão Geral da API
A plataforma Mirox disponibiliza uma API REST para que possa integrar dados de instalações, automação e relatórios nos seus próprios sistemas e fluxos de trabalho. Tudo o que a interface web faz assenta nos mesmos endpoints públicos, pelo que pode controlar a plataforma de forma programática.
Documentação Interativa
A especificação completa da API é gerada em tempo real a partir da plataforma em execução e está disponível em duas vistas interativas:
- Swagger UI em
/docs— uma referência interativa com um construtor de pedidos integrado para experimentar chamadas diretamente no navegador. - ReDoc em
/redoc— a mesma especificação numa disposição otimizada para leitura e navegação.
Ambas as vistas permitem-lhe explorar todos os endpoints disponíveis, os seus parâmetros, o corpo do pedido e o formato da resposta. São a referência autoritativa e sempre atualizada sobre aquilo que a API pode fazer.
Como a API Está Organizada
Os endpoints da API estão agrupados consoante aquilo sobre que atuam, e cada caminho é versionado (por exemplo /v1/...). As áreas comuns incluem:
- Instalações, carteiras e componentes — leia e faça a gestão dos seus locais monitorizados e da sua estrutura.
- Métricas e exportação de dados — obtenha dados de produção e de sensores em CSV ou JSON, ou construa métricas derivadas com MiroxQL.
- Eventos, tickets e relatórios — obtenha sinais detetados por máquina, trabalho de acompanhamento humano e relatórios gerados.
- Organização, cooperações e acesso — faça a gestão de membros, partilha e tokens de integração.
O acesso a cada endpoint é regido pela sua função e pelas suas permissões. Uma chamada devolve apenas as instalações e os dados que tem direito a ver, pelo que a API aplica as mesmas regras de acesso que a interface.
Nem Tudo Está Listado em /docs
Alguns grupos de rotas são intencionalmente ocultados da especificação publicada, pelo que não aparecerão em /docs nem em /redoc mesmo que funcionem:
- Endpoints administrativos — funções de administração da plataforma reservadas ao pessoal da Mirox.
- Rotas de atribuição de dispositivos (
/v1/device).
Se precisar de fazer uma integração com uma destas, contacte o suporte da Mirox para obter orientação.
Acesso Programático a Dados Brutos
Para dados de séries temporais brutos e derivados, utilize o MiroxQL ou a API de Exportação de Métricas. O MiroxQL é a forma suportada de construir e consultar métricas de forma programática.
Como Começar
Para chamar a API, autentica-se com um token de API associado a um grupo de permissões. Consulte o guia Tokens de API para saber como criar, definir o âmbito e rodar tokens, e depois utilize-os para fazer pedidos.
Abrir na Mirox
Crie e faça a gestão dos seus tokens em Perfil — abra o menu de perfil (canto superior direito) ▸ Perfil e utilize a secção de tokens de API.
Para código de integração executável e ponta a ponta, consulte o exemplo prático Gerador de Relatórios Externo.
Funcionalidades Relacionadas
- Tokens de API — crie e faça a gestão dos tokens com âmbito que autenticam as suas chamadas à API
- API de Exportação de Métricas — obtenha dados de produção e de sensores em CSV ou JSON
- MiroxQL — construa e consulte métricas derivadas com o motor de exportação por fórmulas
- Sistema de Permissões — como as funções e os grupos de permissões regem o acesso à API