Support Hub/API & Integrations/Native Push и гибридные режимы: дерево технических решений
Translated from the English article and reviewed by a person. Read the English original
Developer

Native Push и гибридные режимы: дерево технических решений

Native Push и гибридные режимы: дерево технических решений

Каждое биометрическое устройство, подключаемое к 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 отслеживает эту базу данных и в режиме реального времени отправляет новые записи на ваш URL обратного вызова. Прямого обмена с устройством не происходит, поэтому команды на устройство отправить нельзя. Такие операции, как добавление пользователей, удаление записей или загрузка журналов, недоступны.
Callback API: только данные учёта посещаемости и журналы отметок. RESTful API: не поддерживается.
c
File Processing
Только данные учёта посещаемости
Файл учёта посещаемости на локальном компьютере находится под постоянным наблюдением. Каждый раз, когда программное обеспечение устройства обновляет этот файл новыми записями, Gateway обнаруживает изменение, извлекает новые записи и в режиме реального времени отправляет их на ваш 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) всё равно будут в реальном времени доставлять данные учёта посещаемости на ваш конечный адрес обратного вызова, что достаточно для многих сценариев использования.

Hybrid Push: две топологии развёртывания

После выбора способа связи второе решение касается того, где Gateway подключается к вашему устройству, базе данных или файлу. Это решение о топологии, и оно зависит от сетевой среды в физическом месте расположения устройства.

Топология X

Прямая
Компьютер на объекте, к которому подключено устройство или на котором работает программное обеспечение для управления устройством, имеет публичный 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 перед переходом в эксплуатацию.

Was this article helpful?