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

API

Biometric Gateway Web API

Biometric Gateway Web API (також відомий як Universal Biometric Web API 3.0) перетворює будь-який підтримуваний пристрій для відбитків пальців, облич, долоні, вен, райдужки, сітківки, карток чи паролів на підключений до хмари endpoint, з яким ваш застосунок може спілкуватися з будь-якої точки світу. Отримуйте відмітки в реальному часі щойно вони відбулися та віддалено керуйте користувачами на пристрої — усе через простий контракт 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 API (webhook) доставляє відмітки відвідуваності в реальному часі з пристрою на ваш сервер без затримки на опитування
RESTful API для операцій «сервер — пристрій»: Add User, Add User with Templates, Add User Photo, Delete User, Delete All Users, Load Punchlog та інші (38 операцій)
Фіксує кілька типів вхідних даних за відмітку: відбиток пальця, обличчя, картка, долоня, вени пальця, райдужка, сітківка, пароль, а також прапорці температури тіла та маски на обличчі, якщо їх підтримує обладнання
Типи відміток: CheckIn, CheckOut, BreakIn, BreakOut, OverTimeIn, OverTimeOut, MealIn, MealOut
Обробляє офлайнові відмітки: дані з черги передаються послідовно після повторного підключення пристрою
Необов’язкове шифрування AES-256 усіх сирих даних обміну із ключем безпеки, заданим в API Monitor
LoadLog API дає змогу застосункам без сервера та лише з доступом у LAN отримувати на вимогу до 30 днів історії відвідуваності
Задокументовані коди статусів для надійної обробки помилок, із трасуванням за AuthToken пристрою та OperationID для підтримки й звіряння

Створюйте з Biometric Gateway Web API

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

Поговорити з інженером WhatsApp

Поширені запитання

Чи потрібно встановлювати якесь програмне забезпечення у своїй локальній мережі, щоб користуватися Web API?

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

Які біометричні вхідні дані підтримує Web API?

Відбиток пальця, обличчя, картка, долоня, вени пальця, райдужка, сітківка та пароль, а також дані про температуру тіла й маску на обличчі, якщо їх надає обладнання.

Чим Callback API відрізняється від RESTful API?

Callback API — це зв’язок «пристрій — сервер» у реальному часі через URL, який ви відкриваєте на своєму сервері (без затримки). RESTful API — це зв’язок «сервер — пристрій», який ви викликаєте на endpoint Cams для керування пристроєм, із затримкою до приблизно 15 секунд.

Чи можна використовувати API, якщо у мого сервера немає публічного IP?

Так. Використовуйте LoadLog API, щоб на вимогу отримувати журнали відвідуваності за певний період, поки пристрій підключений до інтернету.