Kindra Count

API Local Kindra Count

API para controlar o estado do Kindra Count e consultar dados de contagem.

Versão1.0.0
SegurançaapiKey
HeaderX-API-Key

Autenticação

Envie a chave da API no header da requisição.

X-API-Key: SUA_CHAVE

Controle de Contagem

Endpoints para iniciar e parar o fluxo de contagem.

POST/api/v1/count/play

Iniciar o processo de contagem.

Respostas

StatusDescrição
200Requisição de início bem-sucedida
500Falha na comunicação com o broker MQTT

Exemplo de Resposta

{
  "message": "Play request successful."
}
POST/api/v1/count/stop

Parar o processo de contagem.

Body

{
  "retain": "boolean (optional)"
}

Respostas

StatusDescrição
201Requisição de parada bem-sucedida
500Falha ao parar ou contagem inválida

Exemplo de Resposta

{
  "current_count": 123,
  "message": "Stop request successful"
}

Consulta de Dados

Endpoints para consultar dados de contagem armazenados.

GET/api/v1/load/date

Carregar registros de contagem por intervalo de datas.

Query Params

  • start-datestring (required)
  • end-datestring (optional)

Respostas

StatusDescrição
200Lista de registros de contagem
400Parâmetros de data inválidos ou ausentes
500Falha na consulta ao banco de dados
GET/api/v1/load/id/{record_id}

Carregar registros de contagem por identificador.

Path Params

  • record_idstring (required)

Respostas

StatusDescrição
200Registro de contagem correspondente
500Falha na consulta ao banco de dados
GET/api/v1/total/date

Obter soma total dos valores de contagem por intervalo de datas.

Query Params

  • start-datestring (required)
  • end-datestring (optional)

Respostas

StatusDescrição
200Soma total dos valores de contagem
400Parâmetros de data inválidos ou ausentes
500Falha na consulta ao banco de dados

Exemplo de Resposta

{
  "total": 9999
}