Lesense

API


A API Lesense disponibiliza uma série de recursos REST para armazenamento e recuperação de dados de sensores Lesense.

Esta documentação detalha todos os procedimentos disponíveis para os desenvolvedores de equipamentos que desejam se comunicar com a plataforma e também para desenvolvedores de aplicação que desejam acessar os dados armazenados.

A API está disponível para usuários cadastrados através de protocolo seguro HTTPS no endereço: https://lesense.logicae.com.br/api/.

O endereço base de acesso a API deve ser complementado com a versão que desejam utilizar como por exemplo:

https://lesense.logicae.com.br/api/1.0/

A versão 1.0 é a versão mais recente disponível aos usuários da plataforma. O uso da versão é necessário para manutenção da compatibilidade com equipamentos e aplicações quando novas versões forem lançadas.

Os parâmetros e campos podem ser marcados com as tags([]) listadas abaixo, que dão informações importantes para o desenvolvedor:

[M] - Mandatório - O campo ou parâmetro é obrigatório na requisição

[O] - Opcional - O campo ou parâmetro é opcional na requisição

Autenticação


Para acesso a API o desenolvedor necessita de um token de autenticação.

O token de autenticação é uma string que deve ser enviada junto com toda requisição a API através do parametro token, conforme exemplo abaixo:

https://lesense.logicae.com.br/api/1.0/sensor?token=eyJhbGciOiJIUzI1NiIsImV4c...

Este token possui data de validade que deve ser verificada junto ao gestor de sua conta.

Existem dois tipos de token o de aplicação e o de equipamento. O token de equipamento é associado ao número serial do equipamento e só poderá ser utilizado neste. Os tokens de equipamento também possuem validade e devem ser atualizados sempre que for requisitada a substituição do mesmo através de comando remoto.

Toda requisição enviada sem token de autenticação, com token inválido ou vencido receberá resposta HTTP 401 conforme abaixo:

401

Requisição não autorizada. Token inválido ou expirado.
Data: { "error": "Unauthorized" }

Data e hora


Os dados de data e hora são armazenados na API no fuso horário referência UTC, que é o fuso horário base para todas os outros fusos do mundo.

Ao armazenar os dados, se a informação de data e hora for enviada em fuso diferente de UTC, a data e hora é ajustada para UTC e então armazenada.

O mesmo vale para consultas, onde os filtros utilizados na consulta são convertidos pela API.

Os dados retornados serão apresentados em UTC.