Кожен біометричний пристрій, що підключається до Cams Biometric Gateway, робить це через один з двох push-режимів. Режим, який використовує ваш пристрій, визначає, які API доступні, як доставляються події та як потрібно налаштувати вашу інфраструктуру. Цей посібник розглядає кожну змінну в цьому рішенні: від типу пристрою до методу зв'язку та топології розгортання, щоб ви могли обрати правильний шлях ще до початку розробки.
Перше питання: який тип пристрою ви підключаєте?
Перш ніж обирати метод зв'язку або топологію розгортання, слід відповісти на фундаментальніше питання: чи є ваш пристрій пристроєм Cams Biometrics, чи пристроєм, верифікованим на порталі розробників Cams?
Відповідь на це питання повністю визначає ваш push-режим. Якщо відповідь «так», ви використовуєте Native Push і подальші рішення не потрібні. Якщо відповідь «ні», ви опиняєтеся в зоні Hybrid Push, і далі слід низка додаткових рішень.
Режим 1
Native Push
Для всіх пристроїв Cams Biometrics і будь-якого пристрою, позначеного як верифікований на developer.camsbiometrics.com. Пристрій обмінюється даними безпосередньо з Biometric Gateway через інтернет без додаткового налаштування.
Усі 38 операцій
Повний Callback API
Повний RESTful API
Режим 2
Hybrid Push
Для всіх інших неверифікованих пристроїв. Ви обираєте метод зв'язку та топологію розгортання, що відповідають вашому середовищу. Доступність API залежить від обраної комбінації.
3 методи зв'язку
2 варіанти топології
Змінний доступ до API
Native Push: повна картина
Пристрої Native Push отримують повний доступ до всіх 38 операцій Gateway без жодного налаштування, окрім підключення пристрою до інтернету. Callback API доставляє події без затримки. Команди RESTful API виконуються приблизно за 15 секунд. Не потрібні ні SDK, ні локальне програмне забезпечення, ні рішення щодо топології.
Розуміння Hybrid Push: три методи зв'язку
Якщо ваш пристрій не є пристроєм Cams або верифікованим пристроєм, наступне рішення полягає в тому, як Gateway фактично взаємодіятиме з вашим обладнанням. Доступні три методи зв'язку, кожен із яких має різні вимоги та різні наслідки для того, які функції API ви можете використовувати.
Метод зв'язку не пов'язаний з конфігурацією вашої мережі. Він стосується технічного механізму, яким Gateway зчитує дані з вашого конкретного пристрою та надсилає йому команди. Цей вибір обмежується тим, що підтримує ваше обладнання.
a
Device SDK
Найкращий варіант для повного доступу до API
Gateway взаємодіє з обладнанням за допомогою SDK виробника пристрою. SDK обробляє низькорівневий протокол пристрою, а Gateway надає через свій API всі функції, які підтримує SDK. Це єдиний метод зв'язку в Hybrid Push, який забезпечує операції RESTful API.
Повний Callback API + повний RESTful API (в межах можливостей SDK)
b
DB Pull
Лише дані про відвідуваність
Gateway зчитує дані з локальної бази даних, до якої власне програмне забезпечення для управління пристроєм записує записи про відвідуваність. Gateway відстежує цю базу даних і в режимі реального часу надсилає нові записи на вашу callback-URL-адресу. Прямої взаємодії з пристроєм не відбувається, тобто на пристрій не можна надсилати команди. Такі операції, як додавання користувачів, видалення записів або завантаження журналів, недоступні.
Callback API: лише відвідуваність і журнали відміток. RESTful API: не підтримується.
c
File Processing
Лише дані про відвідуваність
Призначений файл відвідуваності на локальному комп'ютері перебуває під постійним наглядом. Щоразу, коли програмне забезпечення пристрою оновлює цей файл новими записами, Gateway виявляє зміну, витягує нові записи та в режимі реального часу надсилає їх на вашу callback-URL-адресу. Як і DB Pull, цей метод з точки зору пристрою є лише читанням і має ті самі обмеження API.
Callback API: лише відвідуваність і журнали відміток. RESTful API: не підтримується.
Як обрати метод зв'язку
Якщо ваш пристрій має SDK виробника, який підтримується Cams Gateway, оберіть Device SDK (a). Це єдиний метод, який відкриває операції RESTful API для пристроїв Hybrid Push. Якщо SDK не підтримується або недоступний, DB Pull (b) або File Processing (c) все одно доставлятимуть дані про відвідуваність на ваш callback-endpoint у режимі реального часу, що достатньо для багатьох сценаріїв використання.
Розуміння Hybrid Push: дві топології розгортання
Після вибору методу зв'язку друге рішення полягає в тому, де Gateway підключається до вашого пристрою, бази даних або файлу. Це рішення щодо топології, і воно залежить від вашого мережевого середовища у фізичному розташуванні пристрою.
Топологія X
Прямa
Комп'ютер на об'єкті, до якого підключено пристрій або на якому працює програмне забезпечення для управління пристроєм, має публічну IP-адресу з налаштованим перенаправленням портів до локальної мережі. Biometric Gateway підключається безпосередньо до пристрою, бази даних або файлів через інтернет.
Потрібно: публічна IP-адреса + перенаправлення портів на об'єкті
Топологія Y
Непряма
Застосунок Hybrid Connector встановлюється на локальному комп'ютері на об'єкті. Він виконує роль вихідного мосту між локальною машиною та Biometric Gateway, встановлюючи з'єднання зсередини, а не вимагаючи вхідного підключення. На боці клієнта публічна IP-адреса не потрібна.
Потрібно: Hybrid Connector, встановлений на локальному комп'ютері. Публічна IP-адреса не потрібна.
Рекомендація щодо топології
Якщо ви не можете налаштувати публічну IP-адресу або перенаправлення портів на об'єкті, оберіть непряму топологію (Y) з Hybrid Connector. Це найпростіший шлях розгортання, який повністю уникає мережевого налаштування на боці клієнта. Якщо публічна IP-адреса доступна і налаштована, пряма топологія (X) також працює і не потребує додаткового встановлення програмного забезпечення на об'єкті.
Дерево рішень: який режим обрати?
Пройдіть це дерево рішень зверху вниз. Зупиніться на першій відповіді, що стосується вашої ситуації.
Дерево рішень, почніть зверху
1. Чи є ваш пристрій пристроєм Cams Biometrics або чи позначений він як верифікований на developer.camsbiometrics.com?
Так Використовуйте Native Push. Повний доступ до API. Подальші рішення не потрібні.
Ні Перейдіть до питання 2.
2. Чи підтримує Cams Gateway SDK для виробника вашого пристрою?
Так Використовуйте Hybrid Push, Device SDK (a). Повний доступ до Callback і RESTful API в межах обмежень SDK. Перейдіть до питання 3 для вибору топології.
Ні Перейдіть до питання 2b.
2b. Чи записує ваше програмне забезпечення для управління пристроєм записи про відвідуваність у локальну базу даних?
Так Використовуйте Hybrid Push, DB Pull (b). Лише Callback для відвідуваності. Перейдіть до питання 3 для вибору топології.
3. Чи має комп'ютер на об'єкті публічну IP-адресу з доступним перенаправленням портів?
Так Використовуйте Пряма топологія (X). Додаткове програмне забезпечення на об'єкті не потрібне.
Ні Використовуйте непряму топологію (Y). Встановіть Hybrid Connector на локальному комп'ютері на об'єкті.
Матриця доступності функцій Hybrid Push
Нижня таблиця показує всі комбінації методу зв'язку та топології розгортання, а також доступні функції API для кожного випадку. Використовуйте її разом із деревом рішень, щоб підтвердити, що підтримує обрана вами конфігурація.
| Режим |
Зв'язок |
Топологія |
Callback API |
RESTful API |
| Прямий пристрій |
(a) Device SDK |
(X) Публічна IP |
Повний |
Повний (діють обмеження SDK) |
| Непрямий пристрій |
(a) Device SDK |
(Y) Hybrid Connector |
Повний |
Повний (діють обмеження SDK) |
| Пряма БД |
(b) DB Pull |
(X) Публічна IP |
Лише відвідуваність |
Не підтримується |
| Непряма БД |
(b) DB Pull |
(Y) Hybrid Connector |
Лише відвідуваність |
Не підтримується |
| Прямий файл |
(c) File Processing |
(X) Публічна IP |
Лише відвідуваність |
Не підтримується |
| Непрямий файл |
(c) File Processing |
(Y) Hybrid Connector |
Лише відвідуваність |
Не підтримується |
Важливе застереження щодо обладнання
Обмеження обладнання можуть додатково звужувати функції API навіть у режимі Device SDK. Окремі API можуть не працювати залежно від версії прошивки моделі пристрою або можливостей, які надає SDK виробника. Матриця вище описує те, що підтримує архітектура Gateway, а не те, що гарантовано підтримує кожна окрема модель пристрою. Завжди тестуйте на вашому конкретному обладнанні та перевіряйте граничні випадки з командою підтримки Cams перед розгортанням у продуктивному середовищі.
На що впливає і на що не впливає рішення щодо топології
Поширеною плутаниною є зв'язок між топологією та доступністю API. Вибір топології, прямої чи непрямої, не впливає на те, які функції API доступні. Набір функцій API повністю визначається методом зв'язку.
Топологія впливає на те, як встановлюється мережеве з'єднання між Gateway та вашим локальним середовищем. Пряма топологія потребує публічної IP-адреси та перенаправлення портів на об'єкті. Непряма топологія потребує встановлення Hybrid Connector на локальній машині. Функції API, доступні вам, однакові для Direct Device SDK та Indirect Device SDK, а також для Direct DB Pull та Indirect DB Pull.
“Обирайте метод зв'язку відповідно до функцій API, які потрібні вашій інтеграції. Обирайте топологію відповідно до того, що підтримує ваше мережеве середовище. Це незалежні рішення.”
Часті запитання
Чи можна використовувати DB Pull або File Processing разом з командами RESTful API?
Ні. DB Pull і File Processing є інтеграційними методами лише для читання. Вони дозволяють Gateway відстежувати дані про відвідуваність, які генерує власне програмне забезпечення пристрою, але не створюють каналу, через який можна надсилати команди назад на пристрій. Операції RESTful API, такі як додавання користувачів, видалення записів або завантаження журналів, потребують режиму Device SDK, який створює двосторонній канал зв'язку.
Чи потрібно встановлювати Hybrid Connector на тому самому комп'ютері, що й програмне забезпечення пристрою?
Так. Hybrid Connector має бути встановлений на тому самому локальному комп'ютері, до якого підключено пристрій або на якому працює програмне забезпечення для управління пристроєм. Це необхідно, тому що йому потрібен локальний доступ до пристрою, локальної бази даних або файлу відвідуваності, залежно від обраного методу зв'язку. Connector потім створює вихідний тунель до Gateway, тож публічна IP-адреса в цьому місці не потрібна.
Яка різниця в затримці між Native Push і Hybrid Push?
Для Native Push події Callback API доставляються без затримки, а команди RESTful API виконуються приблизно за 30 секунд. Для Hybrid Push з використанням Device SDK затримка залежить від власного циклу зв'язку SDK і відрізняється залежно від виробника пристрою. Затримка DB Pull і File Processing залежить від того, як часто локальне програмне забезпечення записує нові записи і як швидко Gateway виявляє зміну, як правило, протягом кількох секунд після того, як пристрій зафіксує подію.
Висновок: підбирайте режим відповідно до ваших обмежень
Рішення щодо режиму підключення для Cams Biometric Gateway є не питанням переваги, а питанням обмежень. Native Push є правильною відповіддю, якщо ваш пристрій відповідає вимогам, оскільки він забезпечує найбільші можливості з найменшою кількістю налаштувань. Hybrid Push є відповіддю для всіх інших випадків, і в його межах режим Device SDK дає найближчу до Native Push можливість щодо доступу до API.
Якщо повний доступ до SDK недоступний, DB Pull і File Processing є практичними варіантами, які все одно доставляють дані про відвідуваність вашим системам у режимі реального часу. Рішення щодо топології тоді є окремим вибором на рівні інфраструктури, який не змінює того, що може робити API.
Почніть з дерева рішень, перевірте свій вибір за матрицею функцій, протестуйте на вашому обладнанні та перевірте граничні випадки з командою підтримки Cams перед переходом у продуктивне середовище.