Головна / Довідник API

Biometric Gateway API

Один контракт для кожного пристрою. 38 операцій у п’яти групах можливостей, доступні як синхронні виклики REST і webhook Callback у реальному часі.

🌐

Base URL

Усі REST-виклики надсилаються на єдиний версіонований хост.

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

🔑

Автентифікація

Кожен запит містить AuthToken, прив’язаний до вашого облікового запису та пристрою. Ключі видаються на порталі розробника.

📦

Формат

Запити у форматі form-encoded або JSON. Відповіді — JSON із передбачуваними полями та кодами помилок.

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

REST — коли запитуєте ви. Callback — коли щось сталося.

REST

Запит / відповідь

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

  • Синхронно та передбачувано
  • Чудово для синхронізацій, звітів і адміністративних дій
  • Працює з будь-якої мови або cURL
CALLBACK

Webhook у реальному часі

Зареєструйте URL, і шлюз надсилатиме вам події в ту ж мить, коли пристрій їх повідомить — без опитування, з автоматичними повторними спробами в разі збою.

  • Миттєві події відвідуваності та стану
  • Без cron-завдань, без втрачених відміток
  • Повторні спроби, доки ваш endpoint не підтвердить отримання

Операції

Усі 38 операцій

Згруповані за призначенням. Назви відповідають 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-ключа до першого журналу відвідуваності за лічені хвилини.