Вступ
Cams Biometric Gateway — Web API 3.0
Cams Biometric Gateway — універсальний Biometric API, що підключає будь-який біометричний термінал обліку робочого часу чи контролю доступу до вашого застосунку: ERP, HRMS, розрахунку заробітної плати, системи керування школою, власного ПЗ або AI-/автоматизованого робочого процесу. Шлюз підтримує всі провідні бренди пристроїв і надає стандартизований 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
AI-автоматизація (n8n, Zapier)
MCP — Claude · Gemini · ChatGPT
Власні застосунки
Protocol Engine
Захищена обробка автентифікації
Журнал транзакцій даних
Перетворення протоколів
Офлайн-кеш і черга
Шифрування AES-256 · перевірка Auth Token
Шар стандартизованого API
Керування ідентифікацією
Інтеграція з AI / 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, — за три кроки.
Промпти для генерації коду за допомогою AIСкопіюйте промпт у свого AI-асистента, щоб згенерувати код інтеграції для вашого стеку.
Запитання та відповіді, SDK і вартістьПоширені запитання інтеграторів, а також принципи роботи SDK і тарифікації API.
