arrow-left

All pages
gitbookPowered by GitBook
1 of 5

Loading...

Loading...

Loading...

Loading...

Loading...

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

Внимание: данная статья предназначена только для тех, кто пользуется или планирует пользоваться Oz Web SDK на собственных серверах.

circle-exclamation

Если вы используете Oz Web SDK по модели SaaS, пожалуйста, обращайтесь к нашим инженерам.

Настройка Oz Liveness WEB Adapter производится путем изменения конфигурационного файла, расположенного на сервере Oz Liveness WEB Adapter по пути /core/app_config.json

chevron-rightВнимание: информация ниже предназначена только для тех, кто пользуется или планирует пользоваться Oz Web SDK на собственных серверах.hashtag

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

  1. Создайте сервисную учетную запись (по умолчанию срок действия токена такой записи составляет 5 лет).

  2. Установите ПО Postman и скачайте нужную коллекцию API .

  3. Авторизуйтесь с помощью запроса

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

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

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

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

Настройка сервера через переменные окружения

  • WA_CORS_ORIGINS – от каких источников принимать запросы. Значение по умолчанию отсутствует. Если переменная не задана, то CORS headers отключены, т.е. внутри контейнера Web SDK никакие cors headers не будут добавлены!

  • WA_CORS_METHODS(необязательно) – Методы HTTP, которые могут использоваться. Если значение переменной не задано, она принимает значение по умолчанию:

POST
{{host}}/api/authorize/auth
, где
{{host}}
– адрес сервера API. В теле запроса укажите логин и пароль от созданной в п. 1 сервисной учетной записи. Более подробно авторизация описана
.
  • В ответе вам придет параметр access_token. Его значение нужно указать в параметре api_token файла настроек /core/app_config.json. В параметре api_use_token укажите config. Готово.

  • отсюда
    здесьarrow-up-right
    Angulararrow-up-right
    Reactarrow-up-right
    Настройки файла конфигурацииchevron-right
    Настройка Web Adapter через переменные окруженияchevron-right
    Настройка сервера через переменные окруженияchevron-right
    здесь
    'GET, POST, OPTIONS'
    . Если переменная не указана, можно использовать все методы.
  • WA_CORS_HEADERS(необязательно) – Заголовки HTTP, которые могут использоваться. Если значение переменной не задано, она принимает значение по умолчанию: 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,traceparent,esid'. Если переменная не указана, можно использовать все заголовки.

  • Пример настройки CORS headers через переменные окружения:

    docker run -d -p 80:80 \
    -e WA_CORS_ORIGINS='*' \
    -e WA_CORS_METHODS='GET, POST, OPTIONS' \
    -e WA_CORS_HEADERS=DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,traceparent,esid \
    ozforensics/oz-webliveness:{tag}

    Настройка Web Adapter через переменные окружения

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

    • WA_ARCHITECTURE – переопределяет параметр architecture

    • WA_API_URL – переопределяет параметр api_url

    Пример использования переменных окружения при запуске docker-образа Web SDK в режиме Lite.

    docker run -d -p 80:80 \
    -e WA_ARCHITECTURE=lite \
    -e WA_API_URL='http://127.0.0.1:8000/v1/face/liveness/detect' \
    ozforensics/oz-webliveness:{tag}

    Настройки файла конфигурации

    В этом разделе описано содержимое файла конфигурации /core/app_config.json.

    • use_for_liveness – опция применяется при использовании WebSDK операторами банка для съемки клиентов. Если use_for_liveness = true, при съемке лица на мобильных устройствах выбирается тыловая камера, на десктопе отключается флип; отключается обводка овала;

    • preinit – параметр включает предварительную загрузку библиотек и инициализацию, уменьшая время использования plugin. Параметр необязательный, значение по умолчанию off – загрузка скриптов и инициализация происходит после открытия plugin и вызова функции OzLiveness.open(). В таком режиме plugin не создает нагрузки на сайт (приложение), на котором он установлен, но сам plugin может открываться долго из-за описанных выше процессов. Значение script – предварительная загрузка только библиотек плагина. Значение full – предварительная загрузка библиотек и инициализация процесса определения лица.

    • architecture – выбор архитектуры, в которой используется WebSDK. Параметр необязательный, значение по умолчанию normal.

      • normal для включения полной версии Oz API;

    • api_url – адрес сервера Oz API, текстовый параметр;

    • api_token – токен для доступа к Oz API, текстовый параметр;

    • api_use_token – параметр, определяющий источник получения системой токена для доступа к Oz API. Возможные значения = config, client.

      • Если установлено значение client, то токен для доступа к Oz API ожидается от JS-плагина;

    • video_actions_list – блок используемых в системе тегов файлов видео, текстовый массив. .

    • photo_actions_list – блок используемых в системе тегов файлов фотографий, текстовый массив. .

    • actions_default_importance – возможность при запуске анализа переопределить массив действий из WEB-плагина. Возможные значения = true, false;

      • Если установлено true, то адаптер будет использовать массив действий из конфигурационного файла.

    • actions_default – массив действий. Доступные параметры:

      • video_count – количество передаваемых видеофайлов, числовой параметр;

      • photo_front

    • analyses – блок настройки запуска анализов. Доступные параметры:

      • quality – запуск анализа Oz Liveness. Возможные значения = true, false;

    • extract_best_shot – параметр, определяющий необходимость добавления в результат анализа прямой ссылки на лучший кадр, извлеченный из видео. Возможные значения = true, false. Если установлено true, в ответе в output_images (results_media) будет ссылка на извлеченное изображение;

    • result_mode – параметр, определяющий содержание ответа сервера с результатами проверки. Возможные значения:

      • safe – возвращается только состояние анализов (завершены или еще нет);

    • result_codes – блок кодов ответа с комментариями.

    • delete_old_sessions – если установлено true, старые сессии удаляются.

    • delete_old_sessions_offset_minutes – если установлено, старые сессии удаляются с соответствующим смещением в минутах.

    • video_required_actions_list – массив обязательных действий, которые снимающему нужно воспроизвести. См. .

    • save_lossless_frame– если true, исходный кадр сохраняется без сжатия.

    • video_file_format – выбор формата видео, которое отправляется на api. Возможные значения – zip (рекомендуется), mov

    • disable_adapter_errors_on_screen (с версии 1.5.0) – выключает отображение ошибок в модальных окнах, оставляя возможность их просмотра только в коллбэке on_error. Значение по умолчанию – False.

    • auth (с версии 1.7.14) – указывает, используется ли авторизация, и если да, то каким способом:

    lite для использования ;
  • capture – для работы с бэкэндом клиента напрямую. В этом случае возможно распространение Oz Liveness Web Plugin только через статические файлы, без адаптера (работает с версии 0.7.4);

  • Если установлено значение config, то токен берется из параметра api_token файла /core/app_config.json.

    Если установлено false, то адаптер будет использовать массив действий, переданный из браузера методом open(options).

    – наличие фронтальной страницы документа. Возможные значения =
    true
    ,
    false
    ;
  • photo_back – наличие оборотной страницы документа. Возможные значения = true, false.

  • biometry – запуск анализа Oz Biometry. Возможные значения = true, false;

  • documents – запуск анализа Oz Text. Возможные значения = true, false;

  • collection_ids (с версии 1.4.0) – массив идентификаторов коллекций для анализа по черному списку.

  • status
    – возвращаются результаты выполнения анализов;
  • folder – то же самое, что status, но дополнительно возвращается folder_id;

  • full (будет отключен в ближайших релизах) – возвращается полная информация, включая чувствительные данные.

  • (менее безопасный вариант). Чтобы получить видео в MP4, воспользуйтесь инструкцией
    .
  • debug (с версии 1.1.0) – при значении true дает возможность открыть страницу /debug.php, на которой размещена информация о текущих конфигурации и лицензии.

  • load_3d_mask (с версии 1.2.1) – если установлено true, загружает модели для обработки видео, снятого с помощью 3D-маски. Значение по умолчанию – false; в этом случае модель не подгружается, и 3D-маску использовать нельзя (параметр enable_3d_mask игнорируется).

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

  • master_license_signature (с версии 1.3.1) – подпись мастер-лицензии; по умолчанию null.

  • results_polling_interval (с версии 1.4.0) – интервал опроса для получения результатов анализов, мс; значение по умолчанию — 1000.

  • get_user_media_timeout (с версии 1.5.0) – определяет время, по истечении которого отобразится подсказка о том, как получить доступ к камере, если к тому моменту доступ не был получен; default_default для всех браузеров и android_facebook для Facebook браузеров.

  • true (по умолчанию) – включена авторизация на базе генерируемого ключа доступа;

  • user:pass – включена авторизация на базе логина и пароля;

  • false – авторизация выключена.

  • Список актуальных тегов
    Список актуальных тегов
    Active Liveness
    "video_required_actions_list":
    [
        "video_selfie_smile"
    ],
    "get_user_media_timeout": {
            "default_default": 40,
            "android_facebook": 5
        }
    Instant API
    режим
    здесь

    Установка и лицензирование

    Внимание: данная статья предназначена только для тех, кто пользуется или планирует пользоваться Oz Web SDK на собственных серверах.

    circle-exclamation

    Если вы используете Oz Web SDK по модели SaaS, с вопросами по установке и лицензированию, пожалуйста, обращайтесь к нашим инженерам.

    hashtag
    Установка

    Установить SDK можно двумя способами: либо инженеры Oz Forensics делают все вручную, либо используется . В последнем случае потребуется вовлечение ваших специалистов. При установке Oz Web SDK Web Adapter сгенерирует нужные файлы Web Plugin: такие, как файл со стилями (ozliveness.css) и основной скрипт плагина (plugin_liveness.php).

    hashtag
    Лицензирование

    circle-info

    Этот раздел относится в первую очередь к обновлению лицензии, так как при установке Oz Web SDK лицензия также устанавливается, однако в случае надобности вы можете произвести первичную установку лицензии по такому же алгоритму.

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

    circle-info

    Чтобы узнать доменный адрес, в режиме разработчика выполните window.origin на странице, где будет запускаться Web SDK. При использовании Web SDK на localhost / 127.0.0.1 лицензия может работать без информации о доменных именах.

    1. Распакуйте полученный файл.

    2. Скопируйте JSON-файл лицензии на хост, где развернут контейнер из образа ozforensics/oz-webliveness-dev:latest.

    Пример

    • -i ~/ozforensics/keys/id_rsa-test-hostname-vm – путь к публичному ssh-ключу хоста

    • 0000aaaa-00aa-00aa-00aa-00000aaaaa.WebSDK_your_website.2022-10-11.json – файл лицензии в формате JSON.

    • user

    3. Замените файл лицензии.

    Пример

    4. Перезапустите контейнер Web SDK.

    Пример

    • web-sdk – название контейнера, созданного из образа ozforensics/oz-webliveness-dev:latest.

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

    Далее при каждом запуске Web SDK система будет проверять валидность лицензии. Чтобы выполнить проверку вручную, воспользуйтесь методом [GET] /check_license.php.

    hashtag
    Возможные ошибки лицензирования

    – имя пользователя на хосте.
  • hostname – псевдоним хоста.

  • /opt/oz/web-sdk – каталог на хосте, где развернут контейнер Web SDK.

  • Ошибка

    Описание

    License error. License at <> not found

    Файл лицензии не найден

    License error. Cannot parse license from <>, invalid format

    Невозможно прочитать лицензию (файл содержит ошибки)

    License error. Current date is later than license expiration date

    Срок действия лицензии истек, необходимо обновление

    License error. Origin is not in the list permitted by license

    Адрес домена или субдомена не найден в списке адресов, указанных в лицензии

    стационарный установщик
    unzip license.0000aaaa-00aa-00aa-00aa-00000aaaaa.WebSDK_your_website.2022-10-11.json.zip
    scp -i ~/ozforensics/keys/id_rsa-test-hostname-vm license.0000aaaa-00aa-00aa-00aa-00000aaaaa.WebSDK_your_website.2022-10-11.json user@hostname:/opt/oz/web-sdk
    ssh user@hostname -i ~/ozforensics/keys/id_rsa-test-hostname-vm sudo cp -v /opt/oz/web-sdk/license.license.0000aaaa-00aa-00aa-00aa-00000aaaaa.WebSDK_your_website.2022-10-11.json /opt/oz/web-sdk/license.json
    ssh user@hostname -i ~/ozforensics/keys/id_rsa-test-hostname-vm sudo docker restart web-sdk