Работа с контейнером данных OzCapsula в Web SDK

OzCapsula – это разработанный нами проприетарный формат, контейнер данных, обеспечивающий сквозную защиту и целостность информации в процессе передачи. Функциональность добавлена в версии 1.9.2. В режиме работы с контейнером данных SDK снимает видео на устройстве конечного пользователя, затем пакует медиафайлы вместе со всей нужной информацией в контейнер (application/octet-stream), после чего:

• отправляет данные напрямую в Oz API (architecture: normal для полной версии API или lite для Instant API), или

• отправляет данные на ваш бэкенд (architecture: capture).

Также необходим новый токен: session_token.

Конфигурация

Ключевые параметры для использования контейнера

Параметр	Значение	Описание
use_wasm_container	true	Включает функциональность контейнера данныз
architecture	normal / lite/ capture	Определяет, как будут отправляться данные в Oz API – через Web SDK или через ваш бэкенд
api_use_session_token	api / client	Определяет, как будет получен session_token – через Web SDK или запросом в API через ваш бэкенд

Session Token

api_use_session_token: "client"

При таких настройках session token получает ваш бэкенд перед открытием Web SDK.

Шаги:

1. Запросите session token у Oz API:

curl --location '{{host}}/api/authorize/session_token' \
  -H 'X-Forensic-Access-Token: <YOUR_TOKEN>'

1. В ответе придет краткосрочный session_token:

{
  "session_token": "eyJh..."
}

1. Передайте токен в плагин Web SDK:

OzLiveness.open({
  session_token,
  // other open options
});

Session token действителен в течение нескольких минут. Его необходимо запрашивать перед каждой съемкой видео.

api_use_session_token: "api"

При таких настройках SDK получает токен в Oz API автоматически, дополнительно ничего запрашивать или передавать не нужно.

Описание процесса работы для разных архитектур

Процесс работы с контейнером зависит от типа архитектуры, который вы используете.

architecture: "normal"

В режиме normal Web SDK отправляет сгенерированный контейнер данный в Oz API автоматически. Дополнительно ничего загружать не нужно.

architecture: "lite"

В режиме lite Web SDK отправляет сгенерированный контейнер данный в Oz API автоматически. Дополнительно ничего загружать не нужно.

architecture: "capture"

В режиме capture Web SDK только снимает видео и пакует все нужные данные в контейнер, но не отправляет их в Oz API. За передачу данных из Web SDK в Oz API отвечает ваш бэкенд.

Процесс:

1. Web SDK снимает видео и вызывает callback-функцию on_capture_complete(result, container). Второй аргумент этой функции (container) представляет собой Blob-объект (application/octet-stream).

2. Вы отправляете этот объект на свой бэкенд.

3. Ваш бэкенд отправляет этот объект в Oz API запросом HTTPS POST.

Пример запроса:

curl -X POST \
  '{{host}}/api/folders' \
  -H 'Content-Type: application/octet-stream' \
  -H 'X-Forensic-Access-Token: <YOUR_TOKEN>' \
  --data-binary '@/path/to/container.dat'

Ответ будет таким же, как и при процессе без использования контейнера.

Возможные ошибки

Ошибка	Описание
error_wasm_internal_failure_1	Устройство или браузер не поддерживает WASM
error_wasm_internal_failure_2	На устройстве недостаточно памяти
error_wasm_internal_failure_3 error_wasm_internal_failure_4 error_wasm_internal_failure_5	Контейнер создать не удалось. Попробуйте еще раз
error_wasm_internal_failure_1000	Любая другая ошибка не из списка выше