Trabalhando com dados
Comece pelas máquinas, descubra seus sensores e escolha os dados de que sua integração precisa.
Descubra máquinas e sensores#
- Chame
GET /api/v1/machinespara encontrar máquinas disponíveis. Os filtros opcionaissearchestatusrestringem os resultados. - Use
GET /api/v1/machines/{id}/sensorspara descobrir IDs e metadados dos sensores. - Chame
GET /api/v1/machines/{id}/snapshotpara obter os últimos valores disponíveis dos sensores. O parâmetro opcionalatsolicita uma visão instantânea em torno de um momento específico.
Nas próximas requisições, use os identificadores retornados pela API em vez dos nomes de exibição.
Consulte medições históricas#
Chame o endpoint de séries temporais com um a oito IDs de sensores. Repita sensor_id para vários sensores. Substitua os IDs e as datas do exemplo pelos seus.
curl --get 'https://connect-api.iris-cloud.netzsch.com/api/v1/machines/MACHINE_ID/timeseries' \
--header "Authorization: Bearer $CONNECT_API_TOKEN" \
--data-urlencode 'sensor_id=SENSOR_ID' \
--data-urlencode 'from=2026-09-01T00:00:00Z' \
--data-urlencode 'to=2026-09-02T00:00:00Z' \
--data-urlencode 'interval=60000' \
--data-urlencode 'aggregation=avg' \
--data-urlencode 'page=1' \
--data-urlencode 'limit=100'- Datas e horários: use o formato RFC 3339 em UTC, como
2026-09-01T00:00:00Z. - Período: no máximo 30 dias por consulta; o padrão são os últimos sete dias.
- Intervalo: tamanho positivo do intervalo de agregação em milissegundos;
60000equivale a um minuto. - Agregação:
avg,min,max,firstoulast. Requerinterval. Com apenas interval, os intervalos retornam min, max e avg.
A agregação numérica exige valores de sensores compatíveis. A referência descreve o formato exato da resposta.
Leia resultados paginados#
Os endpoints de séries temporais e listagem de lotes aceitam page e limit. As páginas começam em 1; o tamanho padrão é 10 e o máximo é 1000.
Leia os metadados de paginação da resposta e solicite a próxima página até obter todos os resultados necessários. A paginação depende do endpoint; não adicione esses parâmetros a endpoints que não os documentam.
Entenda alarmes e alertas#
Alarmes vêm do CLP da máquina. Alertas são gerados pela plataforma para máquinas e sensores. Ambos os endpoints aceitam from e to, usam os últimos sete dias por padrão e permitem um período máximo de 30 dias.
Consulte lotes de produção#
Use GET /api/v1/batches para listar lotes. Filtre por status, ordene por start_time, end_time, batch_id ou recipe e escolha a direção ASC ou DESC.
Use um ID da lista em GET /api/v1/batches/{id} para consultar os detalhes. Todos os valores de status e campos de resposta aceitos estão na referência da API.