Единый контракт для всех устройств. 38 операций в пяти группах возможностей, доступные как синхронные вызовы REST и webhook Callback в реальном времени.
Все вызовы REST отправляются на единый хост с указанием версии.
https://api.camsbiometrics.com/v3/
Каждый запрос содержит AuthToken, привязанный к вашей учётной записи и устройству. Ключи выдаются на портале разработчика.
Запросы в формате form-encoded или JSON. Ответы — в JSON с предсказуемыми полями и кодами ошибок.
Два способа интеграции
Вы обращаетесь к шлюзу и сразу получаете ответ. Идеально для получения данных посещаемости, списков пользователей, регистрации сотрудника или открытия двери по запросу.
Зарегистрируйте URL, и шлюз отправит вам события в тот же миг, как устройство о них сообщит — без опроса, с автоматическими повторами при сбоях.
Операции
Сгруппированы по назначению. Названия соответствуют 1:1 endpoint шлюза.
Все отметки за период по всей учётной записи.
Журнал по коду одного сотрудника за период.
Отметки, зафиксированные одним устройством по серийному номеру.
Сводка по дням и сотрудникам (приход/уход, часы).
Пара «первый вход / последний выход» по каждому сотруднику за день.
Актуальный снимок сегодняшних отметок.
Фото, сделанные при отметке, если поддерживается.
Массовый экспорт для расчёта зарплаты и сверки.
Создать пользователя на одном или нескольких устройствах.
Изменить имя, роль, срок действия или привилегии.
Удалить пользователя с устройства.
Найти пользователя по коду, при необходимости с учётными данными.
Перечислить всех, кто зарегистрирован на устройстве.
Показать, на каких устройствах есть пользователь.
Отправить шаблон отпечатка на устройство.
Зарегистрировать шаблон лица, если поддерживается.
Назначить пользователю RFID- или бесконтактную карту.
Задать или изменить PIN-код / пароль на устройстве.
Клонировать пользователей и шаблоны между устройствами.
Повторно доставить данные пользователя в очередь устройства.
Мгновенно сработать реле двери, турникета, створки, распашного или откатного шлагбаума.
Заблокировать / удерживать дверь под вашим контролем.
Прочитать текущее состояние: открыто / закрыто.
Задать временные окна доступа.
Журнал входов, выходов и событий двери.
Перечень всех подключённых устройств.
Модель, прошивка, ёмкость и счётчики.
Состояние онлайн, последний выход на связь и глубина очереди.
Проверить доступность устройства прямо сейчас.
Синхронизировать часы устройства с сервером.
Удалённо перезагрузить устройство.
Очистить зависшие команды в очереди.
Отслеживать состояние команды в очереди.
Подписать URL webhook на события в реальном времени.
Срабатывает при каждой отметке в реальном времени.
Переходы онлайн / офлайн и изменения состояния.
Подтверждение того, что шаблон попал на устройство.
Отслеживание хода массовой миграции устройств / данных.
Предсказуемые ответы
| Код | Значение | Что делать |
|---|---|---|
200 | Успешно | Обработайте полезную нагрузку JSON. |
401 | Неверный или отсутствующий AuthToken | Проверьте ключ API и привязку устройства. |
404 | Устройство или пользователь не найдены | Проверьте серийный номер / код сотрудника. |
409 | Устройство офлайн / команда в очереди | Команда поставлена в очередь; опрашивайте GetCommandStatus. |
429 | Превышен лимит запросов | Сделайте паузу и повторите запрос с джиттером. |
Быстрый старт проведёт вас от ключа API до первого журнала посещаемости за считаные минуты.
Мы используем файлы cookie для измерения трафика и улучшения BiometricAPI.com. Аналитика отключена, пока вы не дадите согласие. Подробнее.