API HTTP de frequência

A única entrada HTTPS para qualquer cliente que gere frequência. A API HTTP de frequência autentica por número de série do dispositivo e token e encaminha cada batida reconhecida ao mesmo pipeline de armazenamento e de envio ao cliente de todas as engines nativas da Cams.

Começar Documentação para desenvolvedores

Visão geral

Uma porta de entrada HTTPS independente de dispositivo para receber batidas de frequência, heartbeats e verificações de assinatura de qualquer cliente.

A API HTTP de frequência é a porta de entrada independente de dispositivo no caminho /api/attendance/v1/{op}. Ela autentica cada requisição pelos headers de número de série do dispositivo (sn) e de auth-token e depois faz a ingestão. Ela expõe punch (um evento de frequência reconhecido), heartbeat (presença do dispositivo), validity (verificação de assinatura) e config. As batidas seguem para o pipeline compartilhado, com armazenamento e envio ao servidor do cliente idênticos aos dos transportes nativos HTTP, TCP e MQTT — para que as integrações fiquem consistentes independentemente de como a frequência chega.

APIRESTHTTPSJSONC++

Usado em:Escolas, faculdades e campi

POST /api/attendance/v1/punch

curl https://api.camsbiometrics.com/api/attendance/v1/punch \
  -H "sn: SN7A2300583" -H "auth-token: $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "user_id":"1001", "att_time":"2026-06-21 09:30:00",
        "att_state":1, "input_type":50 }'
# -> 200 {"ok":true}

Recursos

O que ele faz

Ingerir uma batida

Faça POST de um evento de frequência reconhecido com usuário, timestamp, estado ENTRADA/SAÍDA, tipo de entrada e localização opcional.

Informar presença

Envie um heartbeat para marcar um dispositivo como online, sem nenhum corpo de requisição.

Verificar validade

Consulte se a assinatura de frequência do dispositivo está ativa antes de enviar dados.

Pipeline unificado

Toda batida cai no mesmo caminho de armazenamento e envio da ingestão nativa por TCP e MQTT.

Funcionalidades

Tudo incluído

Uma única entrada HTTPS para clientes edge, app, web e híbridos em /api/attendance/v1/{op}
Autenticação por headers: número de série do dispositivo (sn) mais auth-token, com controle por assinatura
O endpoint punch ingere um evento de frequência reconhecido (usuário, horário, ENTRADA/SAÍDA, tipo de entrada, geolocalização opcional)
O endpoint heartbeat marca um dispositivo como online para o acompanhamento de presença
O endpoint validity retorna o status da assinatura em tempo real antes de um cliente enviar dados
Pipeline compartilhado: armazenamento e envio ao servidor do cliente idênticos aos das engines nativas
Contrato de erros JSON consistente para número de série ausente, dispositivo desconhecido, token inválido ou assinatura inativa
Com nginx na frente, com limites de tamanho de corpo e limitação de taxa

Crie com a API HTTP de frequência

Pegue uma chave, leia a documentação e publique. Nossa equipe ajuda na sua primeira integração.

Falar com um engenheiro WhatsApp

FAQ

Perguntas frequentes

O que a API HTTP de frequência faz?

É a porta de entrada independente de dispositivo que aceita batidas de frequência reconhecidas, heartbeats e verificações de assinatura, autentica-os por número de série do dispositivo e token e os envia ao pipeline de frequência compartilhado da Cams.

Como as requisições são autenticadas?

Toda requisição leva um header de número de série do dispositivo (sn) e um header de auth-token; ambos precisam ser válidos. Os endpoints biométricos exigem, além disso, uma assinatura de frequência ativa.

A frequência recebida por HTTP é tratada da mesma forma que a dos dispositivos?

Sim. As batidas seguem para o mesmo pipeline usado pelas engines nativas HTTP, TCP e MQTT, então o armazenamento e o envio posterior são idênticos independentemente do transporte.