Skip to content

Paradas — mify.com.br

Permite consultar os registros de parada e produção (rodando/parado) de uma máquina dentro de um período, com filtros opcionais por grupo e tipo.

Documentação para a plataforma *.mify.com.br. Se você usa *.mify.app.br, veja Paradas — mify.app.br.


iMetrics → ERP

Consulta

O ERP consulta o iMetrics para obter os registros de parada/produção de uma máquina.

ℹ️ Por que POST numa consulta? Esta rota não cria nem altera nada — é uma consulta. Usamos POST em vez de GET porque o corpo da requisição permite mais filtros do que a query string suportaria. Nesta plataforma isso já fica indicado pelo nome da rota: get-running.

Endpoint

POST https://app.mify.com.br/api/v2/integration/external/machine/RAMA 01/get-running
Autenticação
x-api-key: 00000000-0000-0000-0000-000000000000
Parâmetros do Corpo (JSON)
ParâmetroTipoObrigatórioDescriçãoExemplo
startstringNãoData/hora de início (ISO 8601 UTC)"2025-03-01T03:00:00Z"
endstringNãoData/hora de término (ISO 8601 UTC)"2025-03-10T03:00:00Z"
groupstringNãoFiltro por grupo de parada"MANUTENÇÃO"
typestringNãoFiltro por tipo de parada"MECÂNICA"
Exemplo de Requisição — Com filtros
bash
curl --location 'https://app.mify.com.br/api/v2/integration/external/machine/RAMA 01/get-running' \
--header 'x-api-key: 00000000-0000-0000-0000-000000000000' \
--header 'Content-Type: application/json' \
--data '{
    "start": "2025-03-01T03:00:00Z",
    "end": "2025-03-10T03:00:00Z",
    "group": "MANUTENÇÃO",
    "type": "MECÂNICA"
}'
Exemplo de Requisição — Sem filtros
bash
curl --location 'https://app.mify.com.br/api/v2/integration/external/machine/RAMA 01/get-running' \
--header 'x-api-key: 00000000-0000-0000-0000-000000000000' \
--header 'Content-Type: application/json' \
--data '{
    "start": "2025-03-01T03:00:00Z",
    "end": "2025-03-10T03:00:00Z"
}'
Estrutura da Resposta (JSON Array)

A resposta é um array de registros de rodando/parado.

CampoTipoDescrição
machinestringNome da máquina
startstringData/hora de início do registro (ISO 8601 UTC)
endstring | nullData/hora de término; null se em curso
durationMsinteger | nullDuração em milissegundos; null se em curso
event0 | 10 = Parado, 1 = Rodando
groupstring | nullGrupo da parada
subGroupstring | nullSubgrupo da parada
typestring | nullTipo da parada
subTypestring | nullSubtipo da parada
justificationstring | nullJustificativa da parada
programmedstring | nullNome da parada programada
routinestring | nullNome da parada de rotina
Exemplo de Resposta
json
[
    {
        "machine": "RAMA 01",
        "start": "2025-03-05T12:31:04.569Z",
        "end": null,
        "durationMs": null,
        "event": 1,
        "justification": null,
        "group": null,
        "subGroup": null,
        "type": null,
        "subType": null,
        "programmed": null,
        "routine": null
    },
    {
        "machine": "RAMA 01",
        "start": "2025-03-07T19:48:34.295Z",
        "end": "2025-03-07T19:57:14.789Z",
        "durationMs": 520493,
        "event": 0,
        "justification": "Conserto motor cilindro acumulador rama",
        "group": "MANUTENÇÃO",
        "subGroup": "MANUTENÇÃO",
        "type": "MECÂNICA",
        "subType": "MECÂNICA",
        "programmed": null,
        "routine": null
    }
]
Observações
  1. Os campos group, subGroup, type, subType, justification, programmed e routine são null quando a parada não foi informada.
  2. Registros em andamento têm end e durationMs como null.
  3. Paradas informadas sempre terão group + subGroup + type + subType, ou programmed, ou routine.

Webhook

O iMetrics dispara um webhook para o ERP quando um evento de parada ocorre em uma máquina.

O ERP deve expor uma rota que receberá o POST do iMetrics. A URL é configurada no painel do iMetrics.

Endpoint (definido pelo ERP)

POST https://my-erp.com/api/v1/stops/event
Eventos que disparam o webhook
EventoQuando ocorre
stop.startedMáquina parou
stop.endedMáquina voltou a rodar
stop.informedParada foi justificada
Corpo Enviado (JSON)
CampoTipoDescrição
triggerEventstringTipo do evento que disparou o webhook
machinestringNome da máquina
startstringData/hora de início do registro (ISO 8601 UTC)
endstring | nullData/hora de término; null se em curso
durationMsinteger | nullDuração em milissegundos; null se em curso
event0 | 10 = Parado, 1 = Rodando
groupstring | nullGrupo da parada
typestring | nullTipo da parada
justificationstring | nullJustificativa da parada
Exemplo do Corpo Enviado
json
{
    "triggerEvent": "stop.informed",
    "machine": "RAMA 01",
    "start": "2025-03-07T19:48:34.295Z",
    "end": "2025-03-07T19:57:14.789Z",
    "durationMs": 520493,
    "event": 0,
    "group": "MANUTENÇÃO",
    "type": "MECÂNICA",
    "justification": "Conserto motor cilindro acumulador rama"
}