Inicio / Referencia de la API

La Biometric Gateway API

Un único contrato para todos los dispositivos. 38 operaciones en cinco grupos de capacidades, disponibles como llamadas REST síncronas y webhooks Callback en tiempo real.

🌐

URL base

Todas las llamadas REST se dirigen a un único host versionado.

https://api.camsbiometrics.com/v3/

🔑

Autenticación

Cada solicitud lleva AuthToken asociada a tu cuenta y dispositivo. Las claves se emiten desde el portal para desarrolladores.

📦

Formato

Solicitudes codificadas como formulario o en JSON. Las respuestas son JSON con campos y códigos de error predecibles.

Dos formas de integrar

REST cuando preguntas. Callback cuando ocurre.

REST

Solicitud / respuesta

Llamas al gateway y obtienes una respuesta inmediata. Perfecto para consultar asistencia, listar usuarios, registrar a alguien o abrir una puerta bajo demanda.

  • Síncrono y predecible
  • Ideal para sincronizaciones, informes y acciones de administración
  • Funciona desde cualquier lenguaje o con cURL
CALLBACK

Webhooks en tiempo real

Registra una URL y el gateway te envía los eventos en el instante en que un dispositivo los notifica: sin polling y con reintentos automáticos en caso de fallo.

  • Eventos de asistencia y estado al instante
  • Sin tareas cron, sin fichajes perdidos
  • Reintentos hasta que tu endpoint confirme la recepción

Operaciones

Las 38 operaciones

Agrupadas según su función. Los nombres se corresponden 1:1 con los endpoints del gateway.

📊

Asistencia · 8

GET
GetAttendanceByDate

Todos los fichajes dentro de un intervalo de fechas en toda la cuenta.

GET
GetAttendanceByEmployee

Registros de un solo código de empleado durante un periodo.

GET
GetAttendanceByDevice

Fichajes capturados por un dispositivo según su número de serie.

GET
GetAttendanceSummary

Resumen por día y por empleado (entrada/salida, horas).

GET
GetFirstInLastOut

Par primera entrada / última salida por empleado y día.

GET
GetTodayAttendance

Instantánea en vivo de los fichajes de hoy.

GET
GetAttendancePhoto

Fotos capturadas asociadas a un fichaje, cuando el dispositivo lo admite.

GET
ExportAttendance

Exportación masiva para nómina y conciliación.

👤

Usuarios y registro · 12

POST
AddUser

Crea un usuario en uno o varios dispositivos.

POST
UpdateUser

Edita nombre, rol, vigencia o privilegios.

POST
DeleteUser

Elimina un usuario de un dispositivo.

GET
FindUser

Busca un usuario por código, con credenciales opcionales.

GET
ListUsers

Enumera a todos los usuarios registrados en un dispositivo.

GET
ListUserDevices

Muestra en qué dispositivos existe un usuario.

POST
EnrollFingerprint

Envía una plantilla de huella al dispositivo.

POST
EnrollFace

Registra una plantilla facial, cuando el dispositivo lo admite.

POST
EnrollCard

Asigna una tarjeta RFID / de proximidad a un usuario.

POST
SetUserPassword

Establece o cambia un PIN / contraseña del dispositivo.

POST
CopyUsers

Clona usuarios y plantillas entre dispositivos.

POST
ResendUser

Vuelve a entregar los datos de un usuario a la cola de un dispositivo.

🔒

Control de acceso · 5

POST
OpenDoor

Activa un relé de puerta, torniquete, barrera abatible, batiente o de brazo en tiempo real.

POST
LockDoor

Bloquea o mantiene cerrada una puerta bajo tu control.

GET
GetDoorStatus

Lee el estado actual, abierta o cerrada.

POST
SetAccessSchedule

Define franjas horarias de acceso.

GET
GetAccessEvents

Registro de eventos de entrada / salida y de puertas.

📡

Gestión de dispositivos · 8

GET
ListDevices

Inventario de todos los dispositivos conectados.

GET
GetDeviceInfo

Modelo, firmware, capacidad y contadores.

GET
CheckDeviceHealth

Estado en línea, última conexión y profundidad de la cola.

GET
PingConnection

Confirma ahora si un dispositivo es accesible.

POST
SyncDeviceTime

Sincroniza el reloj del dispositivo con el servidor.

POST
RebootDevice

Reinicia un dispositivo de forma remota.

POST
ResetDeviceQueue

Elimina de la cola los comandos bloqueados.

GET
GetCommandStatus

Sigue el estado de un comando en cola.

🔌

Tiempo real, callback y sistema · 5

POST
RegisterCallback

Suscribe una URL de webhook para recibir eventos en vivo.

PUSH
attendance.new

Se dispara con cada fichaje, en tiempo real.

PUSH
device.status

Transiciones de conexión / desconexión y de estado.

PUSH
enrollment.update

Confirmación cuando una plantilla llega a un dispositivo.

GET
MigrationStatus

Sigue el progreso de migraciones masivas de dispositivos / datos.

Respuestas predecibles

Códigos de estado sobre los que puedes actuar

CódigoSignificadoQué hacer
200CorrectoProcesa el payload JSON.
401AuthToken no válido o ausenteComprueba la clave de API y la vinculación del dispositivo.
404Dispositivo o usuario no encontradoVerifica el número de serie / código de empleado.
409Dispositivo sin conexión / en colaEl comando queda en cola; consulta GetCommandStatus.
429Límite de solicitudes superadoEspera y reintenta con jitter.

¿Listo para llamar a tu primer endpoint?

La guía de inicio rápido te lleva en minutos desde la clave de API hasta tu primer registro de asistencia.