初始化
在哪里初始化
尽早初始化 SDK — 通常在包含捕获框架的页面或组件加载时进行。请参阅最佳实践,了解为什么不应该在点击捕获按钮时才初始化。
嵌入凭据
使用 Onboarding 团队提供的凭据实现 UnicoConfig 类:
import { UnicoConfig } from "unico-webframe"
const config = new UnicoConfig()
.setHostname("<YOUR_HOSTNAME>")
.setHostKey("<YOUR_HOST_KEY>");
实例化构建器
创建一个新的 UnicoCheckBuilder 实例:
const unicoCameraBuilder = new UnicoCheckBuilder();
配置资源路径
指定附加文件的路径(如果已添加到您的项目中):
unicoCameraBuilder.setResourceDirectory("/resources");
指定 AI 模型文件的路径(仅智能摄像头模式需要):
unicoCameraBuilder.setModelsPath("https://meusite.com.br/models");
从 3.18.0 版本起自动获取
从 3.18.0 版本开始,SDK 可以自动获取附加资源 — 只需不实现 setResourceDirectory,并确保正确应用 CSP 配置。
配置 CSS Reset(可选)
默认情况下,SDK 会应用 CSS Reset 以确保各组件之间的视觉一致性。要保留您的应用程序 CSS 样式,请禁用此功能:
unicoCameraBuilder.disableCssReset();
环境选择
沙盒与生产之间的选择在初始化期间进行。使用 SDKEnvironmentTypes 枚举:
SDKEnvironmentTypes.PROD— 生产环境SDKEnvironmentTypes.UAT— 预发布环境
import {
UnicoCheckBuilder,
SDKEnvironmentTypes
} from "unico-webframe"
unicoCameraBuilder.setEnvironment(SDKEnvironmentTypes.UAT);
信息
如果未配置,Web SDK 默认使用生产环境。
有关可用环境类型的完整列表,请参阅 API 参考 > 初始化 API。
生命周期
SDK 与后端的身份验证需要几秒钟。请尽早初始化,而不是在用户点击捕获按钮时才初始化 — 否则用户在点击和摄像头打开之间会感受到延迟。