# Запуск плагина {% hint style="info" %} Перед запуском убедитесь, что скрипты плагина загружены. {% endhint %} {% hint style="danger" %} Обратите внимание: кроме особых случаев, лицензию и токен необходимо добавлять на бэкенде. {% endhint %} Для запуска окна плагина следует воспользоваться методом `open(options)`. Параметры: * `options` – объект с настройками: * `token` – (опционально) токен авторизации; * `license` – объект с информацией о лицензии; * `licenseUrl` – строка, содержащая путь к файлу лицензии;\ Внимание: параметры `license` и `licenseUrl` переопределяют серверную лицензию, включая дату её окончания. Используйте их только в случае лицензирования без использования Web Adapter. Если вы используете серверную лицензию, не передавайте эти параметры в `OzLiveness.open()`, иначе вы будете получать ошибку лицензии. * `lang` – строка с идентификатором одного из подключенных языковых пакетов; * `meta` – объект, ключи которого являются названиями метаполей, а значения – их строковыми значениями. [Метаданные](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/metadata) передаются в Oz API и могут быть использованы для получения результатов анализа или поиска; * `params` – объект с идентификаторами и значениями дополнительных параметров: * `extract_best_shot`: `true/false` – запуск выбора лучшего кадра в анализе [Quality](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/api/oz-api/use-cases/liveness); * `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` – специальное действие, которое извлекает из видео лучший кадр и выполняет анализ по нему вместо целого видео.\ С 1 января 2027 года однокадровый анализ (жест One Shot) будет отключен. Пожалуйста, спланируйте [миграцию](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/instrukcii-po-migracii/perekhod-s-odnokadrovogo-analiza) заранее. * `overlay_options` – параметры отображения шаблона документа: * `show_document_pattern`: `true/false` – по умолчанию `true`, отображает картинку-шаблон, при значении `false` остается только прямоугольная рамка; * `on_submit` – callback-функция без аргументов, вызываемая после отправки пользовательских данных на сервер (не применяется в [режиме `capture`](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/sdk/websdk/web-plugin/zapusk-plagina/semka-video-i-opisanie-kollbeka-on_capture_complete)). * `on_capture_complete` – callback-функция с одним аргументом, вызываемая по завершении съемки и возвращающая информацию о снятом видео. Пример возвращаемого объекта показан [здесь](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/sdk/websdk/web-plugin/semka-video-i-opisanie-kollbeka-on_capture_complete#h.rhefdg38l526). * `on_complete` – callback-функция с одним аргументом, вызываемая после окончания проверки и возвращающая результат анализа (не применяется в режиме `capture`). Вид результата зависит от параметра [настройки](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-administratora/web-adapter/nastroiki-faila-konfiguracii) Web Adapter `result_mode`. Описание результата [здесь](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/sdk/websdk/web-plugin/zapusk-plagina/opisanie-kollbeka-on_complete). * `on_result` – callback-функция с одним аргументом, вызываемая раз в несколько секунд в процессе анализа и возвращающая промежуточный результат (не применяется в режиме `capture`). Вид результата зависит от параметра [настройки](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-administratora/web-adapter/nastroiki-faila-konfiguracii) Web Adapter `result_mode`. Описание результата [здесь](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/sdk/websdk/web-plugin/zapusk-plagina/opisanie-kollbeka-on_result). * `on_error` – callback-функция с одним аргументом, вызываемая при ошибке во время съемки и возвращающая информацию об ошибке: код ошибки, сообщение, идентификатор телеметрии для журналирования. * `on_close` – callback-функция без аргументов, вызываемая по окончании проверки после закрытия окна плагина, как ручного, так и автоматического. * `style` – раздел для [настройки интерфейса](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/sdk/websdk/web-plugin/nastroika-interfeisa/nastroika-interfeisa-do-versii-1.0.1). * `device_id` – (опционально) идентификатор используемой камеры. * `enable_3d_mask` (с версии 1.2.1) – включает использование 3D-маски при съемке вместо овала. Параметр работает только при `load_3d_mask`= `true` в [настройках конфигурации адаптера](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-administratora/web-adapter/nastroiki-faila-konfiguracii); значение по умолчанию – `false`. * `cameraFacingMode` (добавлено в 1.4.0) – параметр, определяющий, какую камеру использовать; возможные значения: `user` (передняя камера), `environment` (задняя камера). Этот параметр работает только в том случае, когда для параметра `use_for_liveness` в [файле конфигурации Web Adapter](https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-administratora/web-adapter/nastroiki-faila-konfiguracii) не установлено значение. Если `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 (мс). * С помощью следующих параметров (добавлены в 1.7.15) вы можете управлять поведением SDK при зависании `getUserMedia()`: * `get_user_media_promise_timeout_ms` – по истечении установленного здесь таймаута (в мс) SDK вызовет ошибку или покажет инструкцию для пользователя. Этот параметр представляет собой объект с ключами: `"platform_browser"`, `"browser"`, `"platform"`, `"default"`(приоритет соответствует последовательности). * `get_user_media_promise_timeout_throw_error` – определяет, что именно демонстрирует SDK после таймаута, ошибку (если `true`) или инструкцию (если `false`). Пример: ```javascript OzLiveness.open({ lang: 'en', action: [ 'video_selfie_blank', ], meta: { // если нужно, добавьте метаданные для папки 'transaction_id': 'your unique transaction identifier', // идентификатор транзакции для поиска через Oz API 'end_user_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); } }); ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://doc.ozforensics.com/oz-knowledge-ru/rukovodstva/rukovodstvo-razrabotchika/sdk/websdk/web-plugin/zapusk-plagina.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.