Início / Produtos / APIs / Web API do Biometric Gateway

API

Web API do Biometric Gateway

A Web API do Biometric Gateway (também conhecida como Universal Biometric Web API 3.0) transforma qualquer dispositivo compatível de impressão digital, face, palma, veias, íris, retina, cartão ou senha em um endpoint conectado à nuvem com o qual seu aplicativo pode se comunicar de qualquer lugar do mundo. Receba batidas em tempo real no instante em que acontecem e gerencie usuários no dispositivo remotamente, tudo em um contrato simples de REST mais Callback.

Começar Documentação para desenvolvedores

Visão geral

Conecte qualquer dispositivo biométrico de frequência ou controle de acesso com acesso à internet diretamente à sua aplicação web via HTTP — sem software local, PC nem banco de dados.

A Web API principal da Cams viabiliza a comunicação máquina a servidor entre dispositivos biométricos instalados remotamente e o aplicativo do seu servidor. Um dispositivo se conecta à internet, a frequência é enviada à sua Callback URL (webhook) em tempo real e o seu servidor aciona operações no dispositivo, como adicionar ou excluir usuário, enviar templates, enviar fotos e carregar logs de batidas, por meio de chamadas RESTful. Não é preciso instalar software desktop, manter um banco de dados local nem deixar um PC na LAN. A API é independente de banco de dados e funciona com qualquer linguagem de backend.

APIRESTCallback/Webhook (HTTP POST)MQTT (caminho de conexão persistente EMQX)PHPPythonJavaNode.js

Usado em:Gestão de visitantes Eventos, festivais e estádios

Callback (webhook) — batida em tempo real

# Your Callback URL receives every punch in real time
POST https://yourapp.com/cams/callback
{
  "DeviceSN": "SN7A2300583",
  "EmployeeCode": "1042",
  "AttendanceLog": "2026-06-21 09:02:14",
  "Type": "face",
  "Direction": "CheckIn"
}

Recursos

O que ele faz

Frequência em tempo real

As batidas são enviadas à sua Callback URL no momento em que são registradas no dispositivo.

Gestão remota de usuários

Adicione, exclua, bloqueie e mova usuários e envie templates ou fotos aos dispositivos a partir do seu servidor por chamadas RESTful.

Captura multimodal

Um único contrato atende entradas de impressão digital, face, palma, veias, íris, retina, cartão e senha.

Resiliência offline

As batidas offline ficam em buffer no dispositivo e são reenviadas em ordem assim que a conectividade é restabelecida.

Transporte criptografado

A criptografia AES-256 dos dados brutos pode ser ativada por dispositivo para uma troca de dados segura.

Funcionalidades

Tudo incluído

A Callback API (webhook) entrega batidas de frequência em tempo real do dispositivo ao seu servidor, sem a latência do polling
API RESTful para operações do servidor ao dispositivo: Add User, Add User with Templates, Add User Photo, Delete User, Delete All Users, Load Punchlog e mais (38 operações)
Captura vários tipos de entrada por batida: impressão digital, face, cartão, palma, veias do dedo, íris, retina, senha, além de flags de temperatura corporal e máscara facial onde o hardware suporta
Os tipos de batida incluem CheckIn, CheckOut, BreakIn, BreakOut, OverTimeIn, OverTimeOut, MealIn, MealOut
Trata batidas offline: os dados em fila são transmitidos em sequência quando o dispositivo se reconecta
Criptografia AES-256 opcional de todos os dados brutos trocados, com chave de segurança definida no API Monitor
A LoadLog API permite que aplicações sem servidor e somente em LAN consultem até 30 dias de histórico de frequência sob demanda
Códigos de status documentados para um tratamento de erros robusto, com AuthToken por dispositivo e rastreamento por OperationID para suporte e conciliação

Crie com a Web API do Biometric Gateway

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

Preciso instalar algum software na minha rede local para usar a Web API?

Não. A comunicação acontece via HTTP entre o dispositivo e o seu servidor. Desde que o dispositivo esteja conectado à internet, você recebe a frequência e gerencia usuários sem software local, banco de dados ou PC.

Quais entradas biométricas a Web API suporta?

Impressão digital, face, cartão, palma, veias do dedo, íris, retina e senha, além de dados de temperatura corporal e máscara facial quando o hardware os fornece.

Qual é a diferença entre a Callback API e a API RESTful?

A Callback API é a comunicação em tempo real do dispositivo para o servidor, por meio de uma URL que você expõe no seu servidor (sem latência). A API RESTful é a comunicação do servidor para o dispositivo, que você chama no endpoint da Cams para gerenciar o dispositivo, com latência de até cerca de 15 segundos.

Posso usar a API se o meu servidor não tiver IP público?

Sim. Use a LoadLog API para consultar sob demanda os logs de frequência de um determinado período, desde que o dispositivo esteja conectado à internet.