Paradas — mify.app.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.app.br. Se você usa *.mify.com.br, veja Paradas — mify.com.br.

---

Mify → ERP

Consulta

O ERP consulta a Mify 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 (com /get no path) em vez de GET porque o corpo da requisição permite mais filtros do que a query string suportaria.

Endpoint

POST https://api-integration-example.mify.app.br/v1/get/machine/RAMA 01/running

Autenticação

x-api-key: 00000000-0000-0000-0000-000000000000

Parâmetros do Corpo (JSON)

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
start	string	Não	Data/hora de início (ISO 8601 UTC)	"2025-03-01T03:00:00Z"
end	string	Não	Data/hora de término (ISO 8601 UTC)	"2025-03-10T03:00:00Z"
group	string	Não	Filtro por grupo de parada	"MANUTENÇÃO"
type	string	Não	Filtro por tipo de parada	"MECÂNICA"

Exemplo de Requisição — Com filtros

curl --location 'https://api-integration-example.mify.app.br/v1/get/machine/RAMA 01/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

curl --location 'https://api-integration-example.mify.app.br/v1/get/machine/RAMA 01/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.

Campo	Tipo	Descrição
machine	string	Nome da máquina
start	string	Data/hora de início do registro (ISO 8601 UTC)
end	string | null	Data/hora de término; null se em curso
durationMs	integer | null	Duração em milissegundos; null se em curso
event	0 | 1	0 = Parado, 1 = Rodando
group	string | null	Grupo da parada
subGroup	string | null	Subgrupo da parada
type	string | null	Tipo da parada
subType	string | null	Subtipo da parada
justification	string | null	Justificativa da parada
programmed	string | null	Nome da parada programada
routine	string | null	Nome da parada de rotina

Exemplo de Resposta

[
    {
        "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

A Mify 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 da Mify. A URL é configurada no painel da Mify.

Endpoint (definido pelo ERP)

POST https://my-erp.com/api/v1/stops/event

Eventos que disparam o webhook

Evento	Quando ocorre
stop.started	Máquina parou
stop.ended	Máquina voltou a rodar
stop.informed	Parada foi justificada

Corpo Enviado (JSON)

Campo	Tipo	Descrição
triggerEvent	string	Tipo do evento que disparou o webhook
machine	string	Nome da máquina
start	string	Data/hora de início do registro (ISO 8601 UTC)
end	string | null	Data/hora de término; null se em curso
durationMs	integer | null	Duração em milissegundos; null se em curso
event	0 | 1	0 = Parado, 1 = Rodando
group	string | null	Grupo da parada
type	string | null	Tipo da parada
justification	string | null	Justificativa da parada

Exemplo do Corpo Enviado

{
    "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"
}