A documentação da API também pode ser encontrada em:
https://documenter.getpostman.com/view/8010791/Tz5tYbak
Para poder integrar com o SIoT é necessário você ter o ID da máquina e o KEY-TOKEN gerados pelo portal. Para obter esses dados acesse Criando uma integração no SIoT.
URL
Produção: https://siot-pub.konztec.com/api/v1
Desenvolvimento: https://siot-pub-dev.konztec.com/api/v1Headers
'Content-Type: application/json'
'key-token: token' O header key-token deverá ser parametrizado com o token obtido no portal
Endpoint para enviar leitura do sensor
- /state/sensor
{
"idMachine": "{maquina_conforme_cadastro_plataforma}",
"id": "{sensor_conforme_cadastro_plataforma}",
"date": "{date_leitura_sensor}",
"value": "{valor_leitura_sensor}"
}
Endpoint para enviar uma lista de leitura de sensores
- /state/sensor/many
{
"idMachine": "{maquina_conforme_cadastro_plataforma}",
"sensors": [
{
"id": "{sensor_conforme_cadastro_plataforma}",
"date": "{date_leitura_sensor}",
"value": "{valor_leitura_sensor}"
}
]
}
Retornos
Possíveis retornos da api
- 200 OK -> Resultado com sucesso
{ message: "Salvo", code: "save" }
- 400 BadRequest -> Parâmetro incorreto ou não informado
{ message: "Informe o código", code: "id.required" }
- 401 Unauthorized -> Necessário autorizar
{ message: "Token expirado", code: "token.expired" }
- 403 Forbidden -> Sem autorização para executar ação
{ message: "Usuário não tem permissão", code: "user.not.allowed"}
- 500 Internal server erro -> Erro no servidor
{ message: "Erro", code: "error.get"}
Corpo de retorno
{
"message": mensagem de retorno em português BR
"code": código da mensagem para ser traduzido em outras linguagens
}