Перейти к основному содержимому

Инициализация

Когда инициализировать

Инициализируйте SDK как можно раньше — как правило, при загрузке страницы или компонента, содержащего рамку захвата. Подробнее о том, почему не следует инициализировать по нажатию кнопки захвата, см. в разделе Лучшие практики.

Встраивание учётных данных

Реализуйте класс UnicoConfig с учётными данными, предоставленными командой onboarding:

import { UnicoConfig } from "unico-webframe"

const config = new UnicoConfig()
  .setHostname("<YOUR_HOSTNAME>")
  .setHostKey("<YOUR_HOST_KEY>");
Создание экземпляра builder

Создайте новый экземпляр UnicoCheckBuilder:

const unicoCameraBuilder = new UnicoCheckBuilder();
Настройка путей к ресурсам

Укажите путь к дополнительным файлам (если они добавлены в ваш проект):

unicoCameraBuilder.setResourceDirectory("/resources");

Укажите путь к файлам моделей ИИ (требуется только для умного режима камеры):

unicoCameraBuilder.setModelsPath("https://meusite.com.br/models");
Автозагрузка с версии 3.18.0

Начиная с версии 3.18.0, SDK может автоматически загружать дополнительные ресурсы — просто не реализуйте setResourceDirectory и убедитесь, что конфигурация CSP применена корректно.

Настройка CSS Reset (необязательно)

По умолчанию SDK применяет CSS Reset для обеспечения визуальной согласованности компонентов. Чтобы сохранить стили CSS вашего приложения, отключите эту функцию:

unicoCameraBuilder.disableCssReset();
Выбор среды

Выбор между sandbox и production осуществляется во время инициализации. Используйте перечисление SDKEnvironmentTypes:

  • SDKEnvironmentTypes.PROD — производственная среда
  • SDKEnvironmentTypes.UAT — среда тестирования
import {
  UnicoCheckBuilder,
  SDKEnvironmentTypes
} from "unico-webframe"

unicoCameraBuilder.setEnvironment(SDKEnvironmentTypes.UAT);
информация

Если настройка не выполнена, Web SDK использует производственную среду по умолчанию.

Полный список доступных типов среды см. в разделе Справочник API > API инициализации.

Жизненный цикл

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

Последнее обновление