Introdução
Cams Biometric Gateway — Web API 3.0
O Cams Biometric Gateway é a API biométrica universal que conecta qualquer equipamento biométrico de ponto ou controle de acesso à sua aplicação: ERP, HRMS, folha de pagamento, gestão escolar, software sob medida ou fluxo de trabalho de IA/automação. Ele é compatível com as principais marcas de equipamentos e oferece uma API biométrica JSON sobre HTTP padronizada, independentemente do hardware.
38 operações: 11 APIs de callback (Equipamento → Servidor) e 27 APIs RESTful (Servidor → Equipamento). Todos os payloads são JSON bruto sobre HTTP/HTTPS.
Todos os equipamentos biométricos são compatíveis. Equipamentos Cams, equipamentos verificados e marcas de terceiros (ZKTeco, Suprema, Hikvision, Anviz, Morpho/IDEMIA, Virdi, Mantra, Nitgen, Realtime/Startek, Biomax, Secugen, eSSL, Matrix COSEC e outras). Escolha o
modo de conexão adequado ao seu cenário.
Como funciona
O Biometric Gateway é composto por:
Servidor GatewayPlataforma hospedada na nuvem que inclui o Cams Protocol Engine (tradução de protocolos, normalização de dados, cache offline, autenticação) e a camada de API padronizada que oferece uma interface consistente à sua aplicação.
Protocol EngineO motor central do servidor Gateway, que se comunica com os equipamentos biométricos, traduz os protocolos específicos de cada fabricante e cuida do registro seguro de transações de dados e do gerenciamento de identidades.
Protocol Engine LiteVersão local que pode ser instalada no seu próprio servidor (Windows/Linux) para ambientes somente LAN ou auto-hospedados. A mesma API, implantada localmente.
Integra-se com
OdooERPNextSAPMicrosoft Dynamics
ZohoBitrix24
OrangeHRMBayZatPalmHRuKnowva
FedenaTeachmintEduBricz
RazorPayPayruler
n8nMakeZapier
Claude (MCP)GeminiChatGPT
Aplicações web sob medida
Sua aplicação
ERP
HRMS
Payroll
ERP escolar
Fluxo de trabalho de IA (n8n, Zapier)
MCP — Claude · Gemini · ChatGPT
Aplicativos sob medida
Protocol Engine
Processamento seguro de autenticação
Registro de transações de dados
Tradução de protocolos
Cache e fila offline
Criptografia AES-256 · Validação de AuthToken
Camada de API padronizada
Gerenciamento de identidades
Integração com IA / MCP
Despachante de callbacks
Roteador de comandos REST
Normalização de dados · Suporte a protocolos de várias marcas
Impressão digital
·
Reconhecimento facial
·
Veias da palma
·
Cartão RFID
·
PIN
·
QR / Código de barras
·
Rastreamento por GPS
Equipamentos biométricos — Todas as marcas compatíveis
Cams
ZKTeco
Suprema
Hikvision
Anviz
Morpho / IDEMIA
Virdi
Mantra
Nitgen
Realtime
Biomax
Secugen
eSSL
Matrix
+ Muitas outras
| Tipo de API | Direção | Latência | Caso de uso |
|---|
| API de callback | Equipamento → Seu servidor | Tempo real / latência zero | Receber marcações de ponto e eventos de sincronização de usuários |
| API RESTful | Seu servidor → Equipamento | ~15 segundos | Adicionar/excluir usuários, carregar registros, cadastrar biometrias |
Introdução
Primeiros passos
Integre em três etapas. Seu servidor precisa de uma URL acessível publicamente para receber os callbacks.
1
Configure sua URL de callback
Faça login no portal API Monitor. Defina a URL HTTPS pública do seu servidor como URL de callback dos seus equipamentos. O motor da API enviará (POST) os eventos biométricos a esse endpoint em tempo real.
2
Receba as marcações de ponto
Seu endpoint recebe um POST com corpo JSON bruto; as APIs de callback não precisam de parâmetros de consulta. Valide o AuthToken, processe os dados da marcação e responda com {"status":"done"}.
3
Chame as APIs RESTful para gerenciar usuários e equipamentos
Envie (POST) um comando JSON para a URL do endpoint RESTful fornecida na sua conta do API Monitor, com o seu stgid (Service Tag ID) como parâmetro de consulta. O motor coloca o comando na fila e o equipamento o confirma em cerca de 15 segundos.
Formato do endpoint
| Tipo de API | Método | Como enviar |
|---|
| API de callback (entrada) |
POST |
O equipamento envia para a sua URL configurada. Corpo JSON bruto; sem parâmetros. |
| API RESTful (saída) |
POST |
Você envia (POST) para a URL do endpoint RESTful (disponível na sua conta do API Monitor) com ?stgid=YOUR_SERVICE_TAG_ID e um corpo JSON bruto. |
Responda sempre imediatamente às solicitações de callback. Seu servidor deve retornar {"status":"done"} (HTTP 200) para confirmar o recebimento. Não faça processamento pesado antes de responder: coloque-o em fila.
Documentação
Documentação da API
A referência está dividida por tópicos. Comece pela compatibilidade de equipamentos e depois siga para as operações de callback e REST.
Equipamentos compatíveis e modos de conexãoQuais equipamentos o Gateway suporta, como cada um se conecta (Native Push ou Hybrid Push) e quais operações da API estão disponíveis em cada modo.
Referência da API: arquitetura, campos e códigos de statusOs componentes comuns a todas as operações: fluxo de requisições, campos JSON comuns, tipos de template, códigos de status, portas e criptografia do payload.
APIs de callback: eventos em tempo real do equipamento para o seu servidorTodos os eventos que um equipamento envia para a sua URL de callback, com o JSON que seu servidor recebe e a resposta que ele deve retornar.
APIs RESTful: comandos do seu servidor para o equipamentoComandos que seu servidor envia a um equipamento por meio do Gateway, com o JSON de requisição e de resposta de cada um.
Testando a API localmenteComo receber callbacks de equipamentos em uma máquina de desenvolvimento e testar os comandos REST com o Postman antes de publicar.
Exemplo em PHP: armazenar o ponto biométrico no MySQLUm manipulador de callback em PHP funcional que grava as marcações de ponto no MySQL, em três etapas.
Prompts de IA para gerar códigoCopie um prompt para o seu assistente de IA e gere o código de integração para a sua própria stack.
Perguntas frequentes, SDK e custoDúvidas comuns de integradores, além de como funcionam o SDK e os preços da API.
