API
Consultando os dados
Para acesso aos dados coletados na API Lesense a interface abaixo é disponibilizada com opções de filtros e paginação através de parametros enviados na requisição conforme especificação abaixo.
URL:
/sensor
Método:
GET
URL Params:
token=[string] [M]
attrs=[string] [O]
Respostas
200
Consulta realizada com sucesso.
400
Requisição inválida. Dados enviados não são suficientes ou possuem valores inválidos.
401
Requisição não autorizada. Token inválido ou expirado.
Data: { "error": "Unauthorized" }
Filtros
Os filtros permitem que os dados coletados sejam selecionados de acordo com um ou mais parâmetros de filtro específicados. Todas as opções de filtro podem ser utilizadas individualmente ou em conjunto com quaisquer outras opções disponíveis. O operador AND é o operador lógico utilizado quando mais de um parâmetro é específicado. Todos as respostas as pesquisas respeitam o limite máximo da API que é de 10000 registros em uma única requisição.
before - [string] [O]
Exibir informações com data de coleta anterior ao valor do parâmetro. O valor deve conter uma data em formato UNIX Timestamp, RFC 3339 ou ISO 8601.
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&before=1451645640"
Retorna todos os dados coletados antes de 01/01/2016 as 10:54 da manhã(UTC).
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&before=2016-01-01T10:54:00-03:00"
Retorna todos os dados coletados antes de 01/01/2016 as 10:54 da manhã(UTC -03:00).
after - [string] [O]
Exibir informações com data de coleta posterior ao valor do parâmetro. Assim como o parâmetro before, o valor deve conter uma data em formato UNIX Timestamp, RFC 3339 ou ISO 8601.
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&after=1451645640"
Retorna todos os dados coletados após 01/01/2016 as 10:54 da manhã(UTC).
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&after=2016-01-01T10:54:00-03:00"
Retorna todos os dados coletados após 01/01/2016 as 10:54 da manhã(UTC -03:00).
dbbefore e dbafter - [string] [O]
Os parâmetros dbbefore e dbafter funcionam de forma similar aos parâmetros before e after, porém a data consultada é a data de armazenamento dos dados no Lesense.
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&dbafter=1451645640"
Retorna todos os dados armazenados após 01/01/2016 as 10:54 da manhã(UTC).
serial - [string] [O]
Exibir informações coletadas para o equipamento com número serial igual valor do parâmetro.
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&serial=00-00-00-00-00-00"
Retorna todos os dados coletados para o equipamento com número serial 00-00-00-00-00-00, respeitando o limite máximo da API.
model - [string] [O]
Exibir informações coletadas para os equipamentos com modelo igual ao valor do parâmetro.
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&model=LES-1"
Retorna todos os dados coletados para os equipamentos do modelo LES-1.
ordering - [string] [O]
Selecionar ordenação da query. Aceita 'asc' para timestamp ascendente e 'desc' para timestamp descendente. Default: 'desc'
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&ordering=asc"
Retorna todos os dados coletados para os equipamentos ordenados de modo ascendente.
version - [string] [O]
Exibir informações coletadas para os equipamentos com firmware na versão específica.
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&version=1.0"
Retorna todos os dados coletados para os equipamentos com firmware na versão 1.0.
sensor - [integer] [O]
Exibir informações coletadas para os sensores endereçados na porta específicada dos sensores.
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&sensor=2"
Retorna todos os dados coletados para os sensores da porta 2 de todos os equipamentos com dados coletados.
type - [string] [O]
Exibir informações coletadas para os sensores do tipo específicado.
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&type=Temperature"
Retorna todos os dados coletados para os sensores do tipo Temperature de todos os equipamentos com dados coletados.
Campos personalizados
Sensores podem armazenar dados personalizados, além dos dados básicos exigidos pela API.
Para incluir estes dados personalizados nos resultados da consulta você deve listá-los, separados por vírgula, no campo attrs da requisição.
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&attrs=customfield1,customfield2"
Da mesma forma que os dados básicos, os campos personalizados também pode ser utilizados para filtrar sua consulta a API. Para tal especifique o campo com o prefixo custom. no paramêtro de pesquisa.
Exemplo:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&custom.customfield1=value1"
Paginação
Os recursos de paginação permitem que o desenvolvedor receba os dados solicitados em lotes baseando-se em um número de registro inicial e no número de informações que deseja consultar.
offset - [integer] [O]
Define o número do registro inicial a ser retornado.
limit - [integer] [O]
Define o número limite de registros a serem retornados. A API limita esse valor por padrão ao seu valor máximo aceito que é de 10000 registros em uma única requisição.
Exemplos:
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&after=1451645640&offset=100"
Retorna os dados coletados a partir do centésimo registro após 01/01/2016 as 10:54 da manhã(UTC).
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&after=1451645640&limit=100"
Retorna os 100 primeiros dados coletados após 01/01/2016 as 10:54 da manhã(UTC).
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&after=1451645640&offset=0limit=100"
Retorna os 100 primeiros dados coletados após 01/01/2016 as 10:54 da manhã(UTC)(Página 1).
curl -X GET "https://lesense.logicae.com.br/api/1.0/sensor?token=TOKEN&after=1451645640&offset=100&limit=100"
Retorna os 100 primeiros dados coletados a partir do registro de número 100 após 01/01/2016 as 10:54 da manhã(UTC)(Página 2).
Exemplos
Disponibilizamos algumas aplicações de exemplo do uso da API Lesense em nossa conta no Github.
Você pode acessar o repositório em https://github.com/logica-e/lesense-samples