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