Главная / Продукты / API / Biometric Gateway Web API

API

Biometric Gateway Web API

Biometric Gateway Web API (также известный как Universal Biometric Web API 3.0) превращает любое поддерживаемое устройство для отпечатков, лиц, ладоней, вен, радужки, сетчатки, карт или паролей в облачную конечную точку, с которой ваше приложение может работать из любой точки мира. Получайте отметки в реальном времени в момент события и удалённо управляйте пользователями на устройстве — всё через простой контракт REST плюс Callback.

Начать Документация для разработчиков

Обзор

Подключайте любое биометрическое устройство учёта посещаемости или контроля доступа с выходом в интернет напрямую к вашему веб-приложению по HTTP — без локального ПО, ПК и базы данных.

Флагманский Web API Cams обеспечивает машинное взаимодействие между удалённо установленными биометрическими устройствами и вашим серверным приложением. Устройство подключается к интернету, посещаемость отправляется на ваш Callback URL (webhook) в реальном времени, а ваш сервер управляет операциями устройства — например, добавлением или удалением пользователя, отправкой шаблонов и фотографий, загрузкой журналов отметок — через RESTful-вызовы. Не нужно устанавливать настольное ПО, запускать локальную базу данных или держать ПК в LAN. API не зависит от базы данных и работает с бэкендом на любом языке.

APIRESTCallback/Webhook (HTTP POST)MQTT (путь постоянного соединения EMQX)PHPPythonJavaNode.js

Применяется в:Учёт посетителей События, фестивали и стадионы

Callback (webhook) — отметка в реальном времени

# 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"
}

Возможности

Что он умеет

Посещаемость в реальном времени

Отметки отправляются на ваш Callback URL в момент их записи на устройстве.

Удалённое управление пользователями

Добавляйте, удаляйте, блокируйте и перемещайте пользователей, отправляйте шаблоны или фото на устройства со своего сервера через RESTful-вызовы.

Мультимодальный захват

Один контракт обрабатывает ввод по отпечатку, лицу, ладони, венам, радужке, сетчатке, карте и паролю.

Устойчивость при отсутствии связи

Отметки, сделанные офлайн, буферизуются на устройстве и воспроизводятся по порядку после восстановления связи.

Зашифрованная передача

Шифрование необработанных данных AES-256 можно включить для каждого устройства для безопасного обмена данными.

Функции

Всё включено

Callback (webhook) API доставляет отметки посещаемости с устройства на ваш сервер в реальном времени без задержек на опрос
RESTful API для операций сервер–устройство: Add User, Add User with Templates, Add User Photo, Delete User, Delete All Users, Load Punchlog и другие (38 операций)
Фиксирует несколько типов ввода при каждой отметке: Fingerprint, Face, Card, Palm, Finger Vein, Iris, Retina, Password, а также признаки температуры тела и маски на лице, если оборудование это поддерживает
Типы отметок: CheckIn, CheckOut, BreakIn, BreakOut, OverTimeIn, OverTimeOut, MealIn, MealOut
Обрабатывает офлайн-отметки: данные из очереди передаются по порядку при повторном подключении устройства
Необязательное шифрование AES-256 всех передаваемых необработанных данных с ключом безопасности, заданным в API Monitor
LoadLog API позволяет приложениям без сервера и только в LAN получать по запросу историю посещаемости до 30 дней
Документированные коды состояния для надёжной обработки ошибок, а также AuthToken устройства и трассировка OperationID для поддержки и сверки

Создавайте с Biometric Gateway Web API

Получите ключ, изучите документацию и запускайте. Наша команда поможет с первой интеграцией.

Поговорить с инженером WhatsApp

FAQ

Частые вопросы

Нужно ли устанавливать какое-либо ПО в моей локальной сети для работы с Web API?

Нет. Обмен происходит по HTTP между устройством и вашим сервером. Пока устройство подключено к интернету, вы можете получать данные посещаемости и управлять пользователями без какого-либо локального ПО, базы данных или ПК.

Какие биометрические способы ввода поддерживает Web API?

Отпечаток, лицо, карта, ладонь, вены пальца, радужка, сетчатка и пароль, а также данные о температуре тела и маске на лице, если их предоставляет оборудование.

В чём разница между Callback API и RESTful API?

Callback API — это обмен в реальном времени от устройства к серверу через URL, который вы открываете на своём сервере (без задержки). RESTful API — это обмен от сервера к устройству: вы обращаетесь к endpoint Cams для управления устройством, при этом задержка достигает примерно 15 секунд.

Можно ли использовать API, если у моего сервера нет публичного IP?

Да. Используйте LoadLog API, чтобы получать журналы посещаемости за нужный период по запросу, пока устройство подключено к интернету.