Oz Liveness WEB Plugin
Добавление плагина «OzLiveness» на web-страницу клиента.
Для подключения плагина на страницу необходимо добавить в html-код страницы файл со стилями (ozliveness.css) и основной скрипт плагина (plugin_liveness.php). При подключении плагина можно дополнительно указать необходимые языковые пакеты. Если языковой пакет не передан, будет подключен язык по-умолчанию. Пример кода для добавления:
HTML
<link rel="stylesheet" href="/plugin/ozliveness.css" />
<script src="/plugin_liveness.php?lang=ru|en"></script>
Запуск плагина OzLiveness.
Для запуска окна плагина следует воспользоваться методом open(options). Параметры:
-
options - объект с настройками:
- lang - строка с идентификатором одного из подключенных языковых пакетов;
- meta - объект, ключи которого являются названиями мета-полей, а значения - их строковыми значениями. Мета-данные передаются в Oz API и могут быть использованы для получения результатов анализа (пример работы с 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_zoom_in - приближение лица к камере;
- video_selfie_zoom_out - отдаление лица от камеры;
- video_selfie_scan - сканирование.
- on_submit() - callback-функция, вызываемая после отправки пользовательских данных на сервер.
- on_result(result) - callback-функция, вызываемая несколько раз в процессе анализа и возвращающая промежуточный результат.
- on_complete(result) - callback-функция, вызываемая после окончания проверки.
- on_close() - callback-функция, вызываемая после закрытия окна плагина, будь то закрытие вручную пользователем или автоматически, после окончания проверки.
ВАЖНО: Рекомендации по безопасному использованию модуля.
В целях повышения защищенности от атак с подменой параметра «action» на стороне браузера и противодействия утечке результатов проверки рекомендуется на боевых стендах использовать модуль Oz Liveness WEB SDK только в следующей конфигурации:
- параметр «actions_default_importance» (тут дать гиперссылку на подраздел «Oz Liveness WEB SDK\Oz Liveness WEB Adapter») конфигурационного файла Oz Liveness WEB Adapter установить «true»
- параметр «result_mode» (тут дать гиперссылку на подраздел «Oz Liveness WEB SDK\Oz Liveness WEB Adapter») конфигурационного файла Oz Liveness WEB Adapter установить «safe»
- результаты анализов получать с помощью метода Oz API «Folder [SINGLE]» (GET)
В такой конфигурации параметры запуска модуля Oz Liveness WEB Plugin и результаты проверок хранятся только на защищенных серверах и недоступны для подмены злоумышленниками.
Пример безопасного вызова метода с настройками по-умолчанию.
JS
OzLiveness.open({
lang: 'ru',
meta: {
'client_id': '123',
'session_id': '321'
},
on_complete: function()
{
// ваш код
}
});
Если при запуске плагина не был указан параметр action, то по-умолчанию на стороне пользователя будет вызвана форма проверки Liveness (съемка одного случайно выбранного действия), с последующим запуском анализа QUALITY на стороне Oz API. Настройки по-умолчанию могут быть изменены на стороне сервера.
Использование модуля в режиме внедрения и тестирования.
При внедрении и тестировании модуля Oz Liveness WEB SDK возможно для ускорения процесса использовать его в следующей конфигурации:
- параметр «actions_default_importance» (тут дать гиперссылку на подраздел «Oz Liveness WEB SDK\Oz Liveness WEB Adapter») конфигурационного файла Oz Liveness WEB Adapter установить «false»
- параметр «result_mode» (тут дать гиперссылку на подраздел «Oz Liveness WEB SDK\Oz Liveness WEB Adapter») конфигурационного файла Oz Liveness WEB Adapter установить «full»
Внимание!!! В целях повышения защищенности от атак с подменой параметра «action» на стороне браузера и противодействия утечке результатов проверки НЕ рекомендуется использовать данную конфигурацию на продуктивных контурах.
В таком режиме результат проверки можно получить в плагине в формате JSON. Также в данной конфигурации возможно при запуске плагина в браузере переопределить параметр «action». Примеры использования модуля с переопределением «action»:
Пример вызова метода со съемкой документа и заданным действием Liveness
JS
OzLiveness.open({
lang: 'ru',
meta: {
'client_id': '123',
'session_id': '321'
},
action: ['photo_id_front', 'photo_id_back', 'video_selfie_scan'],
on_complete: function(result)
{
// ваш код
}
});
При указании действий "photo_id_front" и "photo_id_back" будут вызваны формы захвата лицевой и обратной сторон документа, а на Oz API будут запущены анализы DOCUMENTS и BIOMETRY. Указание одного или нескольки действий вида "video_selfie_*" вызовет форму съемки лица пользователя с последующим запуском анализа QUALITY. По завершении анализов результат в виде объекта возвратится в функцию, прописанную в параметре "on_complete".
Пример вызова метода с заданными действиями Liveness без съемки документа
JS
OzLiveness.open({
lang: 'ru',
meta: {
'client_id': '123',
'session_id': '321'
},
action: ['video_selfie_scan', 'video_selfie_left'],
on_complete: function(result)
{
// ваш код
}
});
Указание одного или нескольких действий вида "video_selfie_*" вызовет форму съемки лица пользователя и запуск анализа QUALITY на стороне Oz API. По завершении анализов результат в виде объекта возвратится в функцию, прописанную в параметре "on_complete".
Закрытие плагина OzLiveness.
Для принудительного закрытия окна плагина можно воспользоваться методом close(). При этом все запросы к серверу и callback-функции (кроме on_close) в рамках данной сессии будут остановлены.
Пример использования:
JS
var session_id = 123;
OzLiveness.open({
// Передаем произвольные мета-данные, по которым в дальнейшем сможем идентифицировать сессию в Oz API
meta: {
session_id: session_id
},
// После отправки данных принудительно закрываем окно плагина и самостоятельно запрашиваем результат
on_submit: function()
{
OzLiveness.close();
my_result_function(session_id);
}
});
Скрытие окна плагина OzLiveness без отмены callback'ов.
Чтобы скрыть окно плагина, не отменяя запросы результатов анализов и пользовательские callback'и, можно воспользоваться методом hide(). Метод может пригодиться, если, к примеру, после отправки данных требуется вывести собственный индикатор загрузки.
Пример использования:
JS
OzLiveness.open({
// При получении промежуточного результата, скрываем окно плагина и показываем собсвенные индикаторы загрузки
on_result: function(result)
{
OzLiveness.hide();
if (result.state === 'processing')
{
show_my_loader();
}
},
on_complete: function()
{
hide_my_loader();
}
});
Добавление собственного языкового пакета.
Для добавления нового языкового пакета или модификации существующего следует воспользоваться методом add_lang(lang_id, lang_obj).
Параметры:
- lang_id - строковое значение, которое далее можно использовать в качестве параметра lang метода open();
- lang_obj - объект, ключами которого являются идентификаторы строк перевода, а значениями - сами строки перевода.
Пример использования:
JS
// Редактируем текст кнопки
OzLiveness.add_lang('ru', {
action_photo_button: 'Сделать фото'
});
