Этот коллбэк вызывается после окончания проверки и возвращает результат анализа (не применяется в режиме capture). Вид результата зависит от параметра настройки Web Adapter result_mode.

Safe

Если result_mode установлен как safe, коллбэкon_complete возвращает только состояние анализов:

{
  "state": "finished"
}

Status

При значении status коллбэк возвращает состояние анализов, а также – для каждого типа анализа – название типа, состояние анализа этого типа и вердикт системы.

{
 "state": "finished",
 "analyses": {
   "quality": {
     "state": "finished",
     "resolution": "success"
   }
 }
}

Folder

При значенииfolderвозвращается практически то же самое, что при status, только добавляется идентификатор папки.

{
 "state": "finished",
 "folder_id": "your_folder_id",
 "analyses": {
   "quality": {
     "state": "finished",
     "resolution": "success"
   }
 }
}

Full

В случае, когда result_mode установлен на full, вернется полная информация об анализах:

• все, что вы могли видеть при значении folder;

• временные метки;

• метаданные;

• идентификаторы анализов, компании, группы анализов;

• пороги;

• информация о медиафайлах;

• и так далее.

Этот коллбэк вызывается раз в несколько секунд в процессе анализа и возвращает промежуточный результат (не применяется в режиме capture). Вид результата зависит от параметра настройки Web Adapter result_mode.

Safe

Если result_mode установлен как safe, коллбэк on_result возвращает только состояние анализов:

{
 "state": "processing"
}

или

{
 "state": "finished"
}

Status

При значении status коллбэк возвращает состояние анализов, а также – для каждого типа анализа – название типа, состояние анализа этого типа и вердикт системы.

{
 "state": "processing",
 "analyses": {
   "quality": {
     "state": "processing",
     "resolution": ""
   }
 }
}

или

{
 "state": "finished",
 "analyses": {
   "quality": {
     "state": "finished",
     "resolution": "success"
   }
 }
}

Folder

При значенииfolderвозвращается практически то же самое, что при status, только добавляется идентификатор папки.

{
 "state": "processing",
 "folder_id": "your_folder_id",
 "analyses": {
   "quality": {
     "state": "processing",
     "resolution": ""
   }
 }
}

Full

В случае, когда result_mode установлен на full, вернется:

• пока анализ выполняется – ответ, аналогичный ответу при значении status (в процессе обработки), или

• полная информация об анализах:

  • все, что вы могли видеть при значении folder;

  • временные метки;

  • метаданные;

  • идентификаторы анализов, компании, группы анализов;

  • пороги;

  • информация о медиафайлах;

  • и так далее.

Для запуска окна плагина следует воспользоваться методом open(options). Параметры:

• options – объект с настройками:

  • token – (опционально) токен авторизации;

  • license – объект с информацией о лицензии;

  • licenseUrl – строка, содержащая путь к файлу лицензии;

  • lang – строка с идентификатором одного из подключенных языковых пакетов;

  • meta – объект, ключи которого являются названиями метаполей, а значения – их строковыми значениями. Метаданные передаются в Oz API и могут быть использованы для получения результатов анализа или поиска;

  • params – объект с идентификаторами и значениями дополнительных параметров:

    • extract_best_shot: true/false – запуск выбора лучшего кадра в анализе Quality;

  • action – массив строк с идентификаторами действий, по которым будет проводиться проверка. Доступные действия:

    • photo_id_front – фото лицевой стороны документа;

    • photo_id_back – фото обратной стороны документа;

    • video_selfie_left – поворот головы налево;

    • video_selfie_right – поворот головы направо;

    • video_selfie_down – наклон головы вниз;

    • video_selfie_high – поднятие головы вверх;

    • video_selfie_smile – улыбка;

    • video_selfie_eyes – моргание;

    • video_selfie_scan – сканирование;

    • video_selfie_blank – отсутствие действия, простое селфи.

    • video_selfie_best – специальное действие, которое извлекает из видео лучший кадр и выполняет анализ по нему вместо целого видео.

  • overlay_options – параметры отображения шаблона документа:

    • show_document_pattern: true/false – по умолчанию true, отображает картинку-шаблон, при значении false остается только прямоугольная рамка;

  • on_submit – callback-функция без аргументов, вызываемая после отправки пользовательских данных на сервер (не применяется в режиме capture).

  • on_capture_complete – callback-функция с одним аргументом, вызываемая по завершении съемки и возвращающая информацию о снятом видео. Пример возвращаемого объекта показан здесь.

  • on_complete – callback-функция с одним аргументом, вызываемая после окончания проверки и возвращающая результат анализа (не применяется в режиме capture). Вид результата зависит от параметра настройки Web Adapter result_mode. Описание результата здесь.

  • on_result – callback-функция с одним аргументом, вызываемая раз в несколько секунд в процессе анализа и возвращающая промежуточный результат (не применяется в режиме capture). Вид результата зависит от параметра настройки Web Adapter result_mode. Описание результата здесь.

  • on_error – callback-функция с одним аргументом, вызываемая при ошибке во время съемки и возвращающая информацию об ошибке: код ошибки, сообщение, идентификатор телеметрии для журналирования.

  • on_close – callback-функция без аргументов, вызываемая по окончании проверки после закрытия окна плагина, как ручного, так и автоматического.

  • style – раздел для настройки интерфейса.

  • device_id – (опционально) идентификатор используемой камеры.

  • enable_3d_mask (с версии 1.2.1) – включает использование 3D-маски при съемке вместо овала. Параметр работает только при load_3d_mask= true в настройках конфигурации адаптера; значение по умолчанию – false.

  • cameraFacingMode (добавлено в 1.4.0) – параметр, определяющий, какую камеру использовать; возможные значения: user (передняя камера), environment (задняя камера). Этот параметр работает только в том случае, когда для параметра use_for_liveness в файле конфигурации Web Adapter не установлено значение. Если use_for_liveness установлено любое значение, cameraFacingMode игнорируется.

  • disable_adaptive_aspect_ratio (добавлено в 1.5.0) – выключает автоматическую подстройку соотношения сторон видео к соотношению сторон окна. Значение по умолчанию – False, при стандартных настройках видео подстраивается под ближайшее соотношение из списка: 4:3, 3:4, 16:9, or 9:16. Обратите внимание: для съемки видео на смартфонах нужна портретная ориентация.

  • get_user_media_timeout (добавлено в 1.5.0) – когда SDK не может получить доступ к камере, по истечении этого таймаута появится подсказка, как решить проблему. Значение по умолчанию – 40000 (мс).

Пример:

OzLiveness.open({
    lang: 'en',
    action: [
        'video_selfie_blank',
    ],
    meta: { // если нужно, добавьте метаданные для папки
        'transaction_id': 'your unique transaction identifier', // идентификатор транзакции для поиска через Oz API
        'client_id': 'your client_id',
        'meta_key': 'meta_value',
    },
    on_result: function (result) {
        console.log('on_result', result);
    },
    on_complete: function (result) {
        console.log('on_complete', result);
    },
    on_close: function () {
        console.log('on_close');
    },
    on_capture_complete: function (result) {
        console.log('on_capture_complete', result);
    }
});

Для подключения плагина на страницу необходимо добавить в html-код страницы ссылку на основной скрипт плагина (plugin_liveness.php). web-sdk-root-url – это полученная от нас ссылка на Web Adapter.

<script src="https://web-sdk-root-url/plugin_liveness.php"></script>

<link rel="stylesheet" href="https://web-sdk-root-url/plugin/ozliveness.css" />
<script src="https://web-sdk-root-url/plugin_liveness.php"></script>

Oz Liveness Web SDK представляет собой модуль съемки и отправки медиаданных на анализы из веб-браузера на клиентском устройстве. Поддерживаются все основные браузеры на большинстве устройств. Доступные языки: EN, RU, ES, PT-BR, KK.

Образец кода Oz Liveness Web SDK находится здесь. Чтобы все работало корректно, нужно заменить <web-adapter-url> на полученную от нас ссылку на Web Adapter.

Для Angular и React нужно заменить https://web-sdk.sandbox.ozforensics.com в index.html.

• Образец кода для Angular

• Образец кода для React

Web SDK только работает по протоколу HTTPS (с SSL-шифрованием); на localhost и 127.0.01 можно использовать HTTP для проверки доступности ресурсов.

Oz Liveness Web SDK состоит из двух частей:

1. Клиентская – Oz Liveness Web Plugin. Используется в виде подгружаемого JavaScript-файла в Frontend-приложении клиента.

2. Серверная – Oz Liveness Web Adapter. Устанавливается в виде отдельного серверного модуля с привязкой к Oz API.

Руководства по интеграции:

Oz Web SDK можно развернуть как на ваших серверах, так и на наших (SaaS), в последнем случае разворачиваем и поддерживаем программное обеспечение мы, а вы пользуетесь уже готовым и настроенным продуктом. Свяжитесь с нами для выбора более удобного варианта.

Для работы Web SDK потребуется информация о доменных именах сайтов, где вы будете его использовать (она необходима для оформления лицензии).

Пошаговая инструкция по использованию Web SDK:

1. Интегрируйте плагин в свою страницу.

2. Если вы хотите настроить интерфейс Oz Web SDK под себя, здесь рассказано, как это сделать.

Этот коллбэк вызывается, если в системе возникает какая-либо ошибка. Он возвращает информацию об ошибке и идентификатор телеметрии, с помощью которого можно получить дополнительные данные о причине сбоя.

on_error { 
    "code": "error_code", 
    "event_session_id": "id_of_telemetry_session_with_error", 
    "message": "<error decription>", 
    "context": {}  // дополнительная информация
}

Для настройки интерфейса воспользуйтесь разделом style в методе Ozliveness.open. Изменить можно следующие настройки:

• faceFrame – цвет рамки вокруг лица:

  • faceReady – цвет рамки при правильном расположении лица;

  • faceNotReady – цвет рамки при неправильном положении лица, когда анализ не может быть запущен.

• centerHint – текст подсказки в центре.

  • textSize – размер текста;

  • color – цвет текста;

  • yPosition – позиция по вертикали относительно верха контейнера;

  • letterSpacing – расстояние между буквами;

  • fontStyle – стиль текста (полужирный, курсив и так далее).

• closeButton – кнопка закрытия плагина:

  • image – изображение для кнопки, может быть картинкой в формате PNG или dataURL в base64.

• backgroundOutsideFrame – заливка вне рамки вокруг лица:

  • color – цвет заливки.

Пример:

OzLiveness.open({
  // ...
  style: {
	  //блок для обратной совместимости
    doc_color: "", 
    face_color_success: "",
    face_color_fail: "", 
	//основной блок
    faceFrame: {
      faceReady: "",
      faceNotReady: "",
    },
    centerHint: {
      textSize: "",
      color: "",
      yPosition: "",
      letterSpacing: "", 
      fontStyle: "", 
    },
    closeButton: {
      image: "",
    },
    backgroundOutsideFrame: {
      color: "", 
    },
  },
  // ...
});

При работе с Web SDK ваше приложение обращается к Web Plugin, который работает в контексте браузера. Плагин обменивается информацией с Web Adapter, а тот, в свою очередь – с Oz API.

Образец кода Oz Liveness Web SDK находится здесь. Чтобы все работало корректно, нужно заменить <web-adapter-url> на полученную от нас ссылку на Web Adapter.

Для Angular и React нужно заменить https://web-sdk.sandbox.ozforensics.com в index.html.

• Образец кода для Angular

• Образец кода для React

Для добавления нового языкового пакета или модификации существующего следует воспользоваться методом add_lang(lang_id, lang_obj).

Параметры:

• lang_id – строковое значение, которое далее можно использовать в качестве параметра lang метода open();

• lang_obj– объект, ключами которого являются идентификаторы строк перевода, а значениями – сами строки перевода.

Список идентификаторов языков:

*До версии 1.3.1 назывался pt.

Пример использования:

OzLiveness.add_lang('ru', ruTranslation), гдеruTranslation – объект JSON.

// Редактируем текст кнопки
OzLiveness.add_lang('ru', {
  action_photo_button: 'Сделать фото'
});

Для установки нужного языка укажите его идентификатор в lang:

OzLiveness.open({
    lang: 'es', // идентификатор нужного языка
    ...
});

Вы можете запросить, какие языковые пакеты установлены в Web SDK, с помощью метода ozLiveness.get_langs(). Добавленные вручную локали также отобразятся.

Список всех строковых идентификаторов:

Ключи вида oz_action_*_go относятся к соответствующим жестам. oz_tutorial_camera_* – к подсказкам, как включить камеру для различных браузеров. Остальные – к подсказкам для всех жестов, информационным сообщениям или ошибкам.

Если какие-либо из ключей в вашем языковом пакете отсутствуют, соответствующие строки будут отображаться на английском языке.

1. Обзор

Режим capture работает следующим образом:

1. Oz Web SDK снимает видео и передает его вашему web-приложению в виде последовательности кадров.

2. Web-приложение вызывает ваш бэкэнд и передает в него архив с кадрами.

3. После обработки видео ваш бэкэнд вызывает Oz API для выполнения анализов, после чего получает их результаты.

4. Ваш бэкэнд передает результаты обратно в web-приложение (опционально).

2. Реализация

На стороне сервера необходимо сконфигурировать Web SDK для работы в режиме capture: установить параметру architecture в файле app_config.json значение capture.

В вашем web-приложении добавьте callback-функцию для обработки кадров при открытии плагина Web SDK:

OZLiveness.open({
  ... // другие параметры
  on_capture_complete: function(result) {
         // Код для обработки кадров / отправки его через ваш API, шаг 2 на схеме
  }
})

Структура получаемого объекта зависит от того, была ли обнаружена виртуальная камера.

Виртуальная камера не обнаружена

{
	"action": <action>,
	"best_frame": <bestframe>,
	"best_frame_png": <bestframe_png>,
	"best_frame_bounding_box": {
		"left": <bestframe_bb_left>,
		"top": <bestframe_bb_top>,
		"right": <bestframe_bb_right>,
		"bottom": <bestframe_bb_bottom>
		},
	"best_frame_landmarks": {
		"left_eye": [bestframe_x_left_eye, bestframe_y_left_eye],
		"right_eye": [bestframe_x_right_eye, bestframe_y_right_eye],
		"nose_base": [bestframe_x_nose_base, bestframe_y_nose_base],
		"mouth_bottom": [bestframe_x_mouth_bottom, bestframe_y_mouth_bottom],
		"left_ear": [bestframe_x_left_ear, bestframe_y_left_ear],
		"right_ear": [bestframe_x_right_ear, bestframe_y_right_ear]
		},
	"frame_list": [<frame1>, <frame2>],
	"frame_bounding_box_list": [
		{
		"left": <frame1_bb_left>,
		"top": <frame1_bb_top>,
		"right": <frame1_bb_right>,
		"bottom": <frame1_bb_bottom>
		},
		{
		"left": <frame2_bb_left>,
		"top": <frame2_bb_top>,
		"right": <frame2_bb_right>,
		"bottom": <frame2_bb_bottom>
		},
	],
	"frame_landmarks": [
		{
		"left_eye": [frame1_x_left_eye, frame1_y_left_eye],
		"right_eye": [frame1_x_right_eye, frame1_y_right_eye],
		"nose_base": [frame1_x_nose_base, frame1_y_nose_base],
		"mouth_bottom": [frame1_x_mouth_bottom, frame1_y_mouth_bottom],
		"left_ear": [frame1_x_left_ear, frame1_y_left_ear],
		"right_ear": [frame1_x_right_ear, frame1_y_right_ear]
		},
		{
		"left_eye": [frame2_x_left_eye, frame2_y_left_eye],
		"right_eye": [frame2_x_right_eye, frame2_y_right_eye],
		"nose_base": [frame2_x_nose_base, frame2_y_nose_base],
		"mouth_bottom": [frame2_x_mouth_bottom, frame2_y_mouth_bottom],
		"left_ear": [frame2_x_left_ear, frame2_y_left_ear],
		"right_ear": [frame2_x_right_ear, frame2_y_right_ear]
		}
	],
"from_virtual_camera": null,
"additional_info": <additional_info>
}

Виртуальная камера обнаружена

{
	"action": <action>,
	"best_frame": null,
	"best_frame_png": null,
	"best_frame_bounding_box": null,
	"best_frame_landmarks": null
	"frame_list": null,
	"frame_bounding_box_list": null,
	"frame_landmarks": null,
	"from_virtual_camera": {
	"additional_info": <additional_info>,
		"best_frame": <bestframe>,
		"best_frame_png": <best_frame_png>,
		"best_frame_bounding_box": {
			"left": <bestframe_bb_left>,
			"top": <bestframe_bb_top>,
			"right": <bestframe_bb_right>,
			"bottom": <bestframe_bb_bottom>
			},
		"best_frame_landmarks": {
			"left_eye": [bestframe_x_left_eye, bestframe_y_left_eye],
			"right_eye": [bestframe_x_right_eye, bestframe_y_right_eye],
			"nose_base": [bestframe_x_nose_base, bestframe_y_nose_base],
			"mouth_bottom": [bestframe_x_mouth_bottom, bestframe_y_mouth_bottom],
			"left_ear": [bestframe_x_left_ear, bestframe_y_left_ear],
			"right_ear": [bestframe_x_right_ear, bestframe_y_right_ear]
			},
		"frame_list": [<frame1>, <frame2>],
		"frame_bounding_box_list": [
			{
			"left": <frame1_bb_left>,
			"top": <frame1_bb_top>,
			"right": <frame1_bb_right>,
			"bottom": <frame1_bb_bottom>
			},
			{
			"left": <frame2_bb_left>,
			"top": <frame2_bb_top>,
			"right": <frame2_bb_right>,
			"bottom": <frame2_bb_bottom>
			},
			],
		"frame_landmarks": [
			{
			"left_eye": [frame1_x_left_eye, frame1_y_left_eye],
			"right_eye": [frame1_x_right_eye, frame1_y_right_eye],
			"nose_base": [frame1_x_nose_base, frame1_y_nose_base],
			"mouth_bottom": [frame1_x_mouth_bottom, frame1_y_mouth_bottom],
			"left_ear": [frame1_x_left_ear, frame1_y_left_ear],
			"right_ear": [frame1_x_right_ear, frame1_y_right_ear]
			},
			{
			"left_eye": [frame2_x_left_eye, frame2_y_left_eye],
			"right_eye": [frame2_x_right_eye, frame2_y_right_eye],
			"nose_base": [frame2_x_nose_base, frame2_y_nose_base],
			"mouth_bottom": [frame2_x_mouth_bottom, frame2_y_mouth_bottom],
			"left_ear": [frame2_x_left_ear, frame2_y_left_ear],
			"right_ear": [frame2_x_right_ear, frame2_y_right_ear]
			}
		]
	}
}

Список переменных с их значениями приведен ниже.

Обратите внимание:

• Видео, полученное через Oz Web SDK, – это последовательность кадров. Чтобы отправить его Oz API, поместите кадры в ZIP-архив, затем используйте метод POST {{host}}/api/folders (пройдите по ссылке для ознакомления с коллекцией Postman).

• Вы можете получить из папки видео в формате MP4 video: вызовите метод /api/folders/{{folder_id}}, указав идентификатор папки. В JSON-ответе найдите preview_url в source_media. В preview_url содержится ссылка на видео. Из плагина получить MP4-видео нельзя (только в виде последовательности кадров).

• При использовании архитектуры capture также необходимо добавить в запрос POST {{host}}/api/folders дополнительное поле additional_info. Оно нужно для сбора информации о среде клиента. Пример заполнения тела запроса:

"VIDEO_FILE_KEY": VIDEO_FILE_ZIP_BINARY
"payload": "{
        "media:meta_data": {
           "VIDEO_FILE_KEY": {
              "additional_info": <additional_info>
              }
           }
}"

• Для передачи в Oz API используйте данные без кодирования в base64.

Для настройки интерфейса воспользуйтесь разделом style в методе Ozliveness.open. Полный список настроек приведен после примера.

Пример использования:

baseColorCustomization

Основные цветовые настройки.

baseFontCustomization

Основные настройки шрифта.

titleFontCustomization

Настройки шрифта заголовка.

buttonCustomization

Настройки кнопок.

toolbarCustomization

Настройки панели инструментов.

centerHintCustomization

Настройки подсказки в центре.

hintAnimation

Анимация подсказки.

faceFrameCustomization

Настройки рамки вокруг лица.

documentFrameCustomization

Настройки рамки для съемки документа.

backgroundCustomization

Настройки фона.

antiscamCustomization

Настройки защиты от мошенников: при включении во время записи видео появляется дополнительное сообщение.

versionTextCustomization

Настройки текста версии SDK.

maskCustomization

Настройки 3D-маски, добавленной в версии 1.2.1.

Переход на новый дизайн с предыдущих версий (до 1.0.1)

Таблица соответствия параметров:

Скрытие окна плагина без отмены callback'ов

Чтобы скрыть окно плагина, не отменяя запросы результатов анализов и пользовательские callback'и, воспользуйтесь методом hide(). Метод может пригодиться, если, к примеру, после отправки данных требуется вывести собственный индикатор загрузки.

Закрытие плагина

Для принудительного закрытия окна плагина воспользуйтесь методом close(). При этом все запросы к серверу и callback-функции (кроме on_close) в рамках данной сессии будут остановлены.

Пример использования:

Для работы плагина Oz Liveness браузер должен поддерживать JavaScript ES6. Версия браузера должна быть не ниже указанной в таблице.

*В режиме совместимости с Internet Explorer Web SDK работать не будет, так как не поддерживаются некоторые важные функции.

1.6.15 – 27.12.2024

• Упрощены проверки, требующие от пользователя движения головы: актуально для жестов поворот головы влево или вправо, наклон головы вперёд или назад.

• Пороговая дистанция для жестов, связанных с движением головы, была снижена: актуально для жестов поворот головы влево или вправо, наклон головы вперёд или назад.

• Поведением приложения при обнаружении открытых инструментов разработчика теперь можно управлять.

• Теперь можно настроить сигнатуры методов с помощью контрольной суммы измененной функции, чтобы сделать их доверенными.

• Исправлена ошибка, из-за которой на экране съёмки после захвата жестов с движением головы неверно отображалась стрелка.

• Исправлена ошибка, из-за которой на экране съёмки при отображении фразы "Отлично!" исчезал овал.

• Улучшен поиск лучшего кадра.

• Обновления безопасности.

1.6.12 – 18.10.2024

• Обновления безопасности.

• Исправили ошибку, из-за которой видео могло некорректно создаваться из последовательности кадров.

1.6.0 – 24.06.2024

• Коллбэк-функция on_complete теперь вызывается после изменения общего статуса папки (заявки).

• Обновили инструкции по доступу к камере для браузеров Android Chrome и Facebook. Новые ключи:

  • error_no_camera_access,

  • oz_tutorial_camera_android_chrome_with_screens_title,

  • oz_tutorial_camera_android_chrome_instruction_screen_click_settings,

  • oz_tutorial_camera_android_chrome_instruction_screen_permissions,

  • oz_tutorial_camera_android_chrome_instruction_screen_allow_access,

  • try_again,

  • oz_tutorial_camera_external_browser_button,

  • oz_tutorial_camera_external_browser_manual_open_link,

  • oz_tutorial_camera_external_browser_title.

• Добавили метод get_langs() – с его помощью можно узнать, какие языковые пакеты установлены в Web SDK.

• Добавили ошибку для ситуации, когда происходит обращение к несуществующему языковому пакету.

• Добавили ошибку для ситуации, когда не удалось загрузить необходимые ресурсы. Новый ключ: unable_load_resource.

• Обновили тексты ошибок error_connection_lost и error_service_unavailable.

• Обновили языковые файлы для Web SDK.

• Функция обрезки больше не добавляет полосы к кадрам c разрешением менее 512×512.

1.5.3 – 28.05.2024

• Если доступ к камере отсутствует в течение длительного времени, пользователям теперь показывается инструкция, как его включить. Для всех браузеров, кроме Facebook, отображается инструкция по умолчанию, для Facebook – отдельная.

• Добавили несколько записей в файл локализации Web SDK. Новые ключи локализации:

  • accessing_camera_switch_to_another_browser,

  • error_camera_timeout_instruction,

  • error_camera_timeout_title,

  • error_camera_timeout_android_facebook_instruction.

1.5.0 – 05.05.2024

• Улучшили работу с картоматами: расстояние, на котором может распознаваться лицо пользователя, увеличено.

• Добавили в Web Plugin параметр disable_adaptive_aspect_ratio. Этот параметр выключает подстройку соотношения сторон видео под окно съемки.

• Добавили в Web Plugin параметр get_user_media_timeout: когда SDK не может получить доступ к камере, по истечении этого таймаута появится подсказка, как решить проблему.

• Добавили несколько записей в файл локализации Web SDK. Новые ключи:

  • oz_tutorial_camera_android_edge_browser

  • oz_tutorial_camera_android_edge_instruction

  • oz_tutorial_camera_android_edge_title

  • error_camera_timeout_instruction

  • error_camera_timeout_title

• Если SDK не может найти перевод для какого-либо из имеющихся ключей, соответствующее сообщение будет показываться на английском.

• Бессерверный Web SDK теперь можно распространять через Node Package Manager.

• Демонстрацию ошибок API в модальном окне теперь можно отключить. Установите параметру disable_adapter_errors_on_screen значение True.

• Мобильные браузеры теперь используют основную (заднюю) камеру для съемки документов.

• Обновили образцы кода.

• Исправили ошибку, когда при повторной попытке пользователя пройти сценарий после неудачи 3D-маска не реагировала на лицо.

• Обновления безопасности и журналирования.

1.4.3 – 15.04.2024

• Исправили ошибку, из-за которой при съемке лица в горизонтальной ориентации на мобильных устройствах не показывалось предупреждение о необходимости поворота устройства вертикально.

• У некоторых пользователей ранее наблюдались зависания при использовании WebView. Теперь в этих случаях пользователь может нажать кнопку, чтобы продолжить работу с приложением. В связи с этим обновили файл со строками в разделе локализации. Ключ: tap_to_continue.

1.4.2 – 14.03.2024

• Расширили возможности отладки.

1.4.1 – 27.02.2024

• Крупные обновления безопасности: улучшили защиту от виртуальных камер и модификации JavaScript-кода.

• Улучшили поддержку WebView:

  • Добавили инструкции для неизвестных WebView-браузеров на платформах Android и iOS. Соответствующие события записываются при журналировании.

  • Улучшили интеграцию с React Native: добавили атрибут webkit-playsinline, чтобы запуск камеры в полноэкранном режиме для iOS WebView работал корректно.

• Ошибка работы с iFrame при параметре iframe_allowed = False теперь отображается корректно.

• Новые ключи локализации:

  • oz_tutorial_camera_android_webview_browser

  • oz_tutorial_camera_android_webview_instruction

  • oz_tutorial_camera_android_webview_title

1.4.0 – 07.02.2024

• Web SDK теперь работает и с черным списком: вы можете сравнить лицо из снятого Liveness-медиафайла с лицами из вашей базы данных. Создайте коллекцию (или коллекции) с нужными фотографиями через API или веб-интерфейс и добавьте соответствующий идентификатор (или идентификаторы) в массив analyses.collection_ids в файле конфигурации веб-адаптера.

• Мы вернули поддержку iframe: установите для параметра iframe_allowed в файле конфигурации Web Adapter значение True.

• Интервал опроса для получения результатов анализов теперь можно настраивать. При необходимости измените его в параметре results_polling_interval файла конфигурации Web Adapter.

• Теперь вы можете выбрать, какую камеру использовать, переднюю или заднюю, и через веб-плагин. В методе OzLiveness.open() установите для cameraFacingMode значение user для передней камеры и environment для задней. Этот параметр работает только в том случае, если для параметра use_for_liveness в файле конфигурации веб-адаптера не установлено значение.

• Стили плагина теперь добавляются автоматически. Обратите внимание: удалите стили, которые вы ранее применили к странице клиента вручную (строка <link rel="stylesheet" href="/plugin/ozliveness.css" />), чтобы избежать конфликтов.

• Исправлены некоторые ошибки и улучшено журналирование.

1.3.1 – 12.01.2024

• Улучшили защиту против инъекционных атак.

• Заменили идентификатор языка для бразильского португальского с pt на pt-br согласно стандарту ISO.

• Удалили конфигурационный параметр lang_default.

• Прозрачность 3D-маски теперь можно настраивать.

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

• Добавили параметр master_license_signature в параметры конфигурации Web Adapter.

• Исправили ошибки.

1.2.2 – 15.12.2024

• Улучшили работу SDK.

1.2.1 – 04.11.2023

• Добавили 3D-маску, которая заменяет овал при съемке видео нашим SDK. Для включения маски установите конфигурационному параметру load_3d_mask значение true.

• Обновили телеметрию (журналирование).

1.1.5 – 27.10.2023

• Обновления журналирования.

1.1.4 – 10.2023

• Обновления безопасности.

1.1.3 – 29.09.2023

• Улучшили работу SDK.

1.1.2 – 21.09.2023

• Улучшили работу SDK.

1.1.1 – 29.08.2023

• Исправили ошибки.

1.1.0 – 24.08.2023

• Изменили сигнатуру коллбэка on_error(): теперь он возвращает не только код ошибки, но и сообщение, а также идентификатор телеметрии для журналирования.

• Добавили параметр конфигурации для режима debug. Если он принимает значение True, в Web SDK можно открыть страницу /debug.php, на которой размещена информация о текущих конфигурации и лицензии.

• Исправили несколько ошибок и улучшили журналирование.

1.0.2 – 06.07.2023

• Добавили возможность выбора камеры при запуске плагина (если на устройстве их несколько).

1.0.1 – 01.07.2023

• Полностью переделали дизайн для SDK и демо, в том числе добавили настройки защиты от мошенников: при включении опции во время записи видео появляется дополнительное сообщение. Новые возможности настройки интерфейса описаны здесь.

• Перевели SDK на португальский, испанский и казахский языки.

• Добавили жест Комбо.

• Добавили шкалу прогресса для загрузки медиа.

• Жесты Zoom in и Zoom out больше не поддерживаются.

• Съемка видео в альбомной ориентации теперь работает корректно для планшетов.

• Убрали опцию lang_allow из файла конфигурации Web Adapter.

0.9.1 – 01.03.2023

• В архитектуре capture при обнаружении виртуальной камеры параметр additional_info теперь отображается внутри списка from_virtual_camera.

• Добавили возможность обрезать кадр с лицом без потери качества.

• Координаты "ориентиров" лица для архитектуры capture теперь передаются корректно.

0.9.0 – 20.02.2023

• Улучшили качество съемки;

• Значительно переработали лицензирование:

  • добавили описание ошибок, теперь понятно, что и почему произошло;

  • теперь можно указывать лицензию в JS в процессе работы;

  • при применении в OzLiveness.open() лицензия переписывает предыдущую;

  • лицензия теперь не требует указания порта и протокола;

  • в URL лицензии можно указывать поддомены;

  • информация о лицензии выводится в лог Docker при запуске плагина на сервере;

  • при использовании на localhost и 127.0.01 лицензия больше не запрашивается;

• Коллбэк on_capture_complete вызывается на всех архитектурах по завершении съемки видео и содержит информацию о жестах на этом видео;

• При запуске Oz Web Liveness и Oz Web Adapter их версии теперь выводятся в лог Docker;

• Добавили параметры для передачи при съемке информации о прямоугольнике, в который вписано лицо;

• Убрали неиспользуемое поле adapter_version из метаданных заявки;

• Починили кнопку переключения камер в Google Chrome;

• При старте Web SDK в лог Docker выводятся фактические параметры конфигурации.

0.7.6 – 27.09.2022

• Изменили расширение некоторых файлов системы Oz Forensics с .bin на .dat.

0.7.5

• Ссылки на дополнительные скрипты теперь формируются с использованием адреса основного скрипта.

0.7.4

• Добавили возможность распространять Web SDK только статическими файлами, без адаптера (в режиме capture).

• Web SDK теперь может работать с CDN.

• Теперь можно запускать несколько экземпляров Oz Liveness Web Plugin на разных страницах, в этом случае необходимо указать на этих страницах путь для загрузки скриптов.

0.4.1

• Исправили ошибку экрана съемки.

0.4.0

• Добавили лицензирование, для получения лицензии необходим origin.

• Внешний вид Web SDK теперь можно настраивать.

0.3.2044

• Исправили ошибки интеграции с Angular.

0.3.2043

• Исправили ошибку с отсутствием секции IMAGE_FOLDER в JSON-ответе при включенном lossless-кадре.

0.3.2042

• Исправили ошибки работы с библиотекой ravenjs.

0.3.2041

• Рамку для фото документов теперь можно настроить.

0.3.2012

• Повысили безопасность SDK.

0.3.2009 (0.4.8)

• Названия всех доступных пользователю камер теперь добавляем в метаинформацию.

0.3.2005 (0.4.8)

• В формате видео / режиме zip теперь можно загружать lossless-кадр.

• Best Shot теперь работает корректно.

0.3.2004 (0.4.8)

• В ответах сервера код ошибки и расшифровка теперь передаются раздельно.

0.3.2001 (0.4.6)

• Если режим для SDK настроен в переменных окружения architecture, api_url, то он применяется в настройках автоматически.

• В режиме lite можно выбрать best frame для любого действия.

• В режиме lite фото, отправленное через API, получает статус on_complete только при успешном liveness.

• Можно управлять cors из переменных окружения (по умолчанию заголовки cors не добавляются).

0.3.1999

• Добавили значение folder для result_mode: оно возвращает тот же ответ, что и значение status, но с folder_id.

0.3.1997 (0.4.5)

• Оптимизировали шифрование: теперь шифруем только метаданные, необходимые для расшифровки объекта.

• Оптимизировали отправку данных: теперь изображения отправляются в отдельных полях формы, а не в одном JSON-объекте.

• Добавили проверку поддерживаемых параметров камеры.

0.3.1992 (0.4.4)

• Включили новый метод шифрования изображений.

• Оптимизировали формат отправки изображений.

0.3.1991

• Добавили опцию use_for_liveness: при съемке лица на мобильных устройствах выбирается тыловая камера, а на десктопе отключаются флип и обводка овала. По умолчанию опция отключена.

0.3.1990 (0.4.3)

• Уменьшили время видео video_selfie_best (жест Selfie) с 1 до 0,2 сек.

• Оптимизировали загрузку скриптов – теперь ее можно настраивать.

• Повысили точность работы алгоритмов.

0.3.1988 (0.4.2)

• Добавили казахский язык.

• Добавили инструкцию по доступу к камере для десктопа.

• Дополнили журналирование – пишутся запросы к plugin_liveness.php и user-agent в лог сервера.

• Добавили возможность работы с режимом Lite.

0.3.1987 (0.4.1)

• Добавили шифрование.

• Обновили библиотеки.

0.3.1986 (0.3.91)

• Добавили возможность скрывать логотип Oz Forensics.

0.3.1984

• Дополнили руководства для некоторых браузеров и социальных сетей.

• Добавили обработку неизвестных и руководство для "неизвестных" браузеров.

0.3.1983

• Оптимизировали потребление памяти для рамки.

• Добавили руководство по включению камер в различных браузерах под Android.

Получение и обработка результатов анализа на бэкенде

Результаты анализа доступны клиентскому приложению через функции-коллбэки Web Plugin, однако мы рекомендуем получать их через бэкенд напрямую от Oz API и там же обрабатывать впоследствии. Таким образом исключается вероятность манипуляций с результатами анализов через контекст браузера.

Чтобы найти нужную папку со стороны бэкенда, сделайте следующее:

1. На фронтенде добавьте уникальный идентификатор папки через метаданные:

   Copy

   OzLiveness.open({
     ...
     meta: { 
     // идентификатор пользователя или лида из стороннего лидогенератора
     // передавайте ID, если вам нужно отслеживать несколько попыток от одного и того же пользователя
       'user_id': '<user_or_lead_id>',
     // уникальный идентификатор попытки
       'transaction_id': '<unique_id1>'
     }
   });

   Вы можете добавить собственные пары ключ-значение для хранения любой текстовой информации, например, номера документа или телефона. Однако удостоверьтесь при этом, что соблюдаются нормы законодательства о защите персональной информации.

2. Для оповещения о завершении анализа используйте функцию-коллбэк on_result, затем вызовите бэкенд и передайте значение transaction_id.

3. На стороне бэкенда найдите папку по присвоенному ранее идентификатору с помощью метода Folder LIST:

   Copy

   /api/folders/?meta_data=transaction_id==unique_id1&with_analyses=true

   Для ускорения обработки запроса мы рекомендуем ограничить выдачу по времени:

   Copy

   /api/folders/?meta_data=transaction_id==unique_id1&with_analyses=true&time_created.min=([CURRENT_TIME]-1hour)

4. В ответе придут результаты анализов и идентификатор папки folder_id - он потребуется для дальнейших действий.

Ограничение объема данных, которые сервер отправляет Web Plugin

Web Adapter отправляет Web Plugin данные с различным уровнем детализации. Для продакшна рекомендуется установить минимальный уровень. Для этого в файле конфигурации Web Adapter установите параметру result_mode значение "safe".

"result_mode": "safe"

Для выпуска лицензии потребуется информация о доменных именах сайтов, где будет использоваться Web SDK. Можно также указывать поддомены.

Укажите информацию о лицензии одним из двух способов:

• через данные о лицензии:

OzLiveness.open({
    license: {
        'payload_b64': 'some_payload',
        'signature': 'some_data',
        'enc_public_key': 'some_key'
    },
    ...,
})

• через путь к лицензии:

OzLiveness.open({
    licenseUrl: 'https://some_url',
    ...,
})

Проверьте, как установилась лицензия: например, пройдите по доменному имени хоста и выполните действие Liveness -> Simple selfie.

Далее при каждом запуске Web SDK система будет проверять валидность лицензии.