Главная / Справочник API

Biometric Gateway API

Единый контракт для всех устройств. 38 операций в пяти группах возможностей, доступные как синхронные вызовы REST и webhook Callback в реальном времени.

🌐

Базовый URL

Все вызовы REST отправляются на единый хост с указанием версии.

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

🔑

Аутентификация

Каждый запрос содержит AuthToken, привязанный к вашей учётной записи и устройству. Ключи выдаются на портале разработчика.

📦

Формат

Запросы в формате form-encoded или JSON. Ответы — в JSON с предсказуемыми полями и кодами ошибок.

Два способа интеграции

REST — когда вы спрашиваете. Callback — когда событие происходит.

REST

Запрос / ответ

Вы обращаетесь к шлюзу и сразу получаете ответ. Идеально для получения данных посещаемости, списков пользователей, регистрации сотрудника или открытия двери по запросу.

  • Синхронно и предсказуемо
  • Отлично подходит для синхронизации, отчётов и административных действий
  • Работает с любого языка или через cURL
CALLBACK

Webhook в реальном времени

Зарегистрируйте URL, и шлюз отправит вам события в тот же миг, как устройство о них сообщит — без опроса, с автоматическими повторами при сбоях.

  • Мгновенные события посещаемости и состояния
  • Без cron-задач и пропущенных отметок
  • Повторы, пока ваш endpoint не подтвердит получение

Операции

Все 38 операций

Сгруппированы по назначению. Названия соответствуют 1:1 endpoint шлюза.

📊

Посещаемость · 8

GET
GetAttendanceByDate

Все отметки за период по всей учётной записи.

GET
GetAttendanceByEmployee

Журнал по коду одного сотрудника за период.

GET
GetAttendanceByDevice

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

GET
GetAttendanceSummary

Сводка по дням и сотрудникам (приход/уход, часы).

GET
GetFirstInLastOut

Пара «первый вход / последний выход» по каждому сотруднику за день.

GET
GetTodayAttendance

Актуальный снимок сегодняшних отметок.

GET
GetAttendancePhoto

Фото, сделанные при отметке, если поддерживается.

GET
ExportAttendance

Массовый экспорт для расчёта зарплаты и сверки.

👤

Пользователи и регистрация · 12

POST
AddUser

Создать пользователя на одном или нескольких устройствах.

POST
UpdateUser

Изменить имя, роль, срок действия или привилегии.

POST
DeleteUser

Удалить пользователя с устройства.

GET
FindUser

Найти пользователя по коду, при необходимости с учётными данными.

GET
ListUsers

Перечислить всех, кто зарегистрирован на устройстве.

GET
ListUserDevices

Показать, на каких устройствах есть пользователь.

POST
EnrollFingerprint

Отправить шаблон отпечатка на устройство.

POST
EnrollFace

Зарегистрировать шаблон лица, если поддерживается.

POST
EnrollCard

Назначить пользователю RFID- или бесконтактную карту.

POST
SetUserPassword

Задать или изменить PIN-код / пароль на устройстве.

POST
CopyUsers

Клонировать пользователей и шаблоны между устройствами.

POST
ResendUser

Повторно доставить данные пользователя в очередь устройства.

🔒

Контроль доступа · 5

POST
OpenDoor

Мгновенно сработать реле двери, турникета, створки, распашного или откатного шлагбаума.

POST
LockDoor

Заблокировать / удерживать дверь под вашим контролем.

GET
GetDoorStatus

Прочитать текущее состояние: открыто / закрыто.

POST
SetAccessSchedule

Задать временные окна доступа.

GET
GetAccessEvents

Журнал входов, выходов и событий двери.

📡

Управление устройствами · 8

GET
ListDevices

Перечень всех подключённых устройств.

GET
GetDeviceInfo

Модель, прошивка, ёмкость и счётчики.

GET
CheckDeviceHealth

Состояние онлайн, последний выход на связь и глубина очереди.

GET
PingConnection

Проверить доступность устройства прямо сейчас.

POST
SyncDeviceTime

Синхронизировать часы устройства с сервером.

POST
RebootDevice

Удалённо перезагрузить устройство.

POST
ResetDeviceQueue

Очистить зависшие команды в очереди.

GET
GetCommandStatus

Отслеживать состояние команды в очереди.

🔌

Реальное время, callback и система · 5

POST
RegisterCallback

Подписать URL webhook на события в реальном времени.

PUSH
attendance.new

Срабатывает при каждой отметке в реальном времени.

PUSH
device.status

Переходы онлайн / офлайн и изменения состояния.

PUSH
enrollment.update

Подтверждение того, что шаблон попал на устройство.

GET
MigrationStatus

Отслеживание хода массовой миграции устройств / данных.

Предсказуемые ответы

Коды состояния, по которым удобно ветвить логику

КодЗначениеЧто делать
200УспешноОбработайте полезную нагрузку JSON.
401Неверный или отсутствующий AuthTokenПроверьте ключ API и привязку устройства.
404Устройство или пользователь не найденыПроверьте серийный номер / код сотрудника.
409Устройство офлайн / команда в очередиКоманда поставлена в очередь; опрашивайте GetCommandStatus.
429Превышен лимит запросовСделайте паузу и повторите запрос с джиттером.

Готовы вызвать первый endpoint?

Быстрый старт проведёт вас от ключа API до первого журнала посещаемости за считаные минуты.