Введение
Cams Biometric Gateway — Web API 3.0
Cams Biometric Gateway — универсальный Biometric API, который подключает любой биометрический терминал учёта рабочего времени или контроля доступа к вашему приложению: ERP, HRMS, расчёту заработной платы, системе управления школой, собственному ПО или ИИ-/автоматизированному рабочему процессу. Шлюз поддерживает все ведущие бренды устройств и предоставляет стандартизированный Biometric API на основе JSON поверх HTTP независимо от оборудования.
38 операций — 11 Callback API (устройство → сервер) и 27 RESTful API (сервер → устройство). Все payload передаются в виде чистого JSON по HTTP/HTTPS.
Поддерживаются все биометрические терминалы. Терминалы Cams, проверенные устройства и сторонние бренды (ZKTeco, Suprema, Hikvision, Anviz, Morpho/IDEMIA, Virdi, Mantra, Nitgen, Realtime/Startek, Biomax, Secugen, eSSL, Matrix COSEC и другие). Выберите
режим подключения, подходящий для вашей инфраструктуры.
Как это работает
Biometric Gateway состоит из следующих компонентов:
Сервер шлюзаОблачная платформа, включающая Cams Protocol Engine (преобразование протоколов, нормализация данных, офлайн-кэширование, аутентификация) и слой стандартизированного API, который предоставляет вашему приложению единый интерфейс.
Protocol EngineЯдро сервера шлюза, которое обменивается данными с биометрическими устройствами, преобразует протоколы разных производителей, ведёт защищённый журнал транзакций данных и управляет идентификацией.
Protocol Engine LiteЛокальная версия, которую можно установить на собственный сервер (Windows/Linux) для сред только с LAN или для самостоятельного размещения. Тот же API, развёртывание на вашей стороне.
Интеграции
OdooERPNextSAPMicrosoft Dynamics
ZohoBitrix24
OrangeHRMBayZatPalmHRuKnowva
FedenaTeachmintEduBricz
RazorPayPayruler
n8nMakeZapier
Claude (MCP)GeminiChatGPT
Собственные веб-приложения
Ваше приложение
ERP
HRMS
Расчёт зарплаты
Школьная ERP
ИИ-автоматизация (n8n, Zapier)
MCP — Claude · Gemini · ChatGPT
Собственные приложения
Protocol Engine
Защищённая обработка аутентификации
Журнал транзакций данных
Преобразование протоколов
Офлайн-кэш и очередь
Шифрование AES-256 · проверка Auth Token
Слой стандартизированного API
Управление идентификацией
Интеграция с ИИ / MCP
Диспетчер callback
Маршрутизатор REST-команд
Нормализация данных · поддержка протоколов многих брендов
Отпечаток пальца
·
Распознавание лиц
·
Вены ладони
·
RFID-карта
·
PIN-код
·
QR / штрихкод
·
GPS-отслеживание
Биометрические устройства — поддерживаются все бренды
Cams
ZKTeco
Suprema
Hikvision
Anviz
Morpho / IDEMIA
Virdi
Mantra
Nitgen
Realtime
Biomax
Secugen
eSSL
Matrix
+ и многие другие
| Тип API | Направление | Задержка | Сценарий использования |
|---|
| Callback API | Устройство → ваш сервер | В реальном времени / нулевая задержка | Получение отметок посещаемости и событий синхронизации пользователей |
| RESTful API | Ваш сервер → устройство | ~15 секунд | Добавление и удаление пользователей, загрузка журналов, регистрация биометрии |
Введение
Начало работы
Интеграция в три шага. Вашему серверу нужен общедоступный URL для приёма callback.
1
Настройте Callback URL
Войдите на портал API Monitor. Укажите общедоступный HTTPS URL вашего сервера в качестве Callback URL для ваших устройств. Движок API будет отправлять биометрические события на этот endpoint методом POST в реальном времени.
2
Получайте отметки посещаемости
Ваш endpoint получает POST с чистым JSON в теле запроса — для Callback API параметры запроса не нужны. Проверьте AuthToken, разберите данные отметки и ответьте {"status":"done"}.
3
Вызывайте RESTful API для управления пользователями и устройствами
Отправьте POST с JSON-командой на URL RESTful endpoint из вашей учётной записи API Monitor, передав stgid (Service Tag ID) в параметре запроса. Движок ставит команду в очередь, и устройство подтверждает её в течение ~15 секунд.
Формат endpoint
| Тип API | Метод | Способ отправки |
|---|
| Callback API (входящий) |
POST |
Устройство отправляет данные на ваш настроенный URL. Чистый JSON в теле запроса, без параметров. |
| RESTful API (исходящий) |
POST |
Вы отправляете POST на URL RESTful endpoint (он указан в вашей учётной записи API Monitor) с параметром ?stgid=YOUR_SERVICE_TAG_ID и чистым JSON в теле запроса. |
Всегда отвечайте на Callback-запросы немедленно. Ваш сервер должен вернуть {"status":"done"} (HTTP 200), подтверждая получение. Не выполняйте ресурсоёмкую обработку до ответа — поставьте её в очередь.
Документация
Документация по API
Справочник разбит по темам. Начните с совместимости устройств, затем переходите к операциям callback и REST.
Поддерживаемые устройства и режимы подключенияКакие терминалы поддерживает шлюз, как подключается каждый из них (Native Push или Hybrid Push) и какие операции API доступны в каждом режиме.
Справочник API: архитектура, поля и коды статусовБазовые элементы, общие для всех операций: схема запросов, общие поля JSON, типы шаблонов, коды статусов, порты и шифрование payload.
Callback API: события в реальном времени от устройства к вашему серверуВсе события, которые устройство отправляет на ваш callback URL, с JSON, получаемым вашим сервером, и ответом, который он должен вернуть.
RESTful API: команды от вашего сервера к устройствуКоманды, которые ваш сервер отправляет устройству через шлюз, с JSON запроса и ответа для каждой.
Локальное тестирование APIКак принимать callback от устройств на машине разработчика и тестировать REST-команды в Postman до развёртывания.
Пример на PHP: хранение биометрической посещаемости в MySQLГотовый обработчик callback на PHP, который сохраняет отметки посещаемости в MySQL, — в три шага.
Промпты для генерации кода с помощью ИИСкопируйте промпт в своего ИИ-ассистента, чтобы сгенерировать код интеграции для вашего стека.
Вопросы и ответы, SDK и стоимостьЧастые вопросы интеграторов, а также принципы работы SDK и тарификации API.
