Um único contrato para todos os dispositivos. 38 operações em cinco grupos de recursos, disponíveis como chamadas REST síncronas e webhooks de Callback em tempo real.
Todas as chamadas REST são feitas para um único host versionado.
https://api.camsbiometrics.com/v3/
Toda requisição leva uma AuthToken associada à sua conta e ao seu dispositivo. As chaves são emitidas no portal do desenvolvedor.
Requisições codificadas como formulário ou em JSON. As respostas são em JSON, com campos e códigos de erro previsíveis.
Duas formas de integrar
Você chama o gateway e recebe uma resposta imediata. Perfeito para consultar frequência, listar usuários, cadastrar alguém ou abrir uma porta sob demanda.
Registre uma URL e o gateway envia os eventos para você no instante em que um dispositivo os reporta — sem polling, com novas tentativas automáticas em caso de falha.
Operações
Agrupadas pelo que fazem. Os nomes correspondem 1:1 aos endpoints do gateway.
Todas as batidas em um intervalo de datas em toda a conta.
Logs de um único código de funcionário em um período.
Batidas capturadas por um dispositivo, identificado pelo número de série.
Resumo por dia e por funcionário (entrada/saída, horas).
Par primeira entrada / última saída por funcionário por dia.
Panorama ao vivo das batidas de hoje.
Fotos capturadas junto com a batida, quando houver suporte.
Exportação em massa para folha de pagamento e conciliação.
Cria um usuário em um ou mais dispositivos.
Edita nome, perfil, validade ou privilégios.
Remove um usuário de um dispositivo.
Busca um usuário pelo código, com credenciais opcionais.
Lista todos os cadastrados em um dispositivo.
Mostra em quais dispositivos um usuário existe.
Envia um template de impressão digital ao dispositivo.
Registra um template facial, quando houver suporte.
Atribui um cartão RFID / de proximidade a um usuário.
Define ou altera o PIN / senha do dispositivo.
Clona usuários e templates entre dispositivos.
Reenvia os dados de um usuário para a fila do dispositivo.
Aciona em tempo real o relé de uma porta, catraca, flap, swing ou cancela.
Tranca / mantém uma porta sob o seu controle.
Lê o estado atual, aberta / fechada.
Define janelas de acesso por horário.
Log de eventos de entrada / saída e de portas.
Inventário de todos os dispositivos conectados.
Modelo, firmware, capacidade e contadores.
Estado online, último contato e tamanho da fila.
Confirma agora se o dispositivo está acessível.
Alinha o relógio do dispositivo com o do servidor.
Reinicia um dispositivo remotamente.
Remove da fila os comandos travados.
Acompanha o estado de um comando na fila.
Inscreve uma URL de webhook para eventos ao vivo.
Disparado a cada batida, em tempo real.
Transições online / offline e de saúde do dispositivo.
Confirmação quando um template chega a um dispositivo.
Acompanha o progresso de migrações em massa de dispositivos / dados.
Respostas previsíveis
| Código | Significado | O que fazer |
|---|---|---|
200 | Sucesso | Processe o payload JSON. |
401 | AuthToken inválido ou ausente | Verifique a chave de API e o pareamento do dispositivo. |
404 | Dispositivo ou usuário não encontrado | Confira o número de série / código do funcionário. |
409 | Dispositivo offline / na fila | O comando está na fila; consulte GetCommandStatus. |
429 | Limite de requisições excedido | Aguarde e tente novamente com jitter. |
O guia de início rápido leva você da chave de API ao primeiro log de frequência em minutos.
Usamos cookies para medir o tráfego e melhorar o BiometricAPI.com. As análises ficam desativadas até você aceitar. Saiba mais.