跳转到主要内容

文件采集

采集身份证件。SDK 会呈现一个框架，辅助用户定位证件；定位完成后，用户点击按钮拍照。

无内容验证

SDK 不对正在采集的内容进行任何类型的验证。

可用的文件框架
框架描述
DocumentCameraTypes.CPF采集 CPF
DocumentCameraTypes.CNH采集已展开的 CNH
DocumentCameraTypes.CNH_FRENTE采集 CNH 正面
DocumentCameraTypes.CNH_VERSO采集 CNH 背面
DocumentCameraTypes.RG_FRENTE采集 RG 正面
DocumentCameraTypes.RG_VERSO采集 RG 背面
DocumentCameraTypes.RG_FRENTE_NOVO采集新版 RG 正面
DocumentCameraTypes.RG_VERSO_NOVO采集新版 RG 背面
DocumentCameraTypes.OTHERS("descrição")适用于任何其他文件的通用框架
通用框架

如果需要采集没有专用框架的文件（例如 RNE），请使用 DocumentCameraTypes.OTHERS("description") — 这是一个通用的矩形框架，可用于引导任何采集操作。

有关支持的文件类型的完整列表，请参阅 API 参考 > 枚举。

框架尺寸

建议在您的应用程序中配置框架的大小，以优化采集区域。

CSS 干扰

框架功能可能会受到带有网格组件的设计系统（Bootstrap、Material-UI 等）的影响。为降低此风险，请将框架（id="box-camera"）放置在不会继承不需要的 CSS 规则的位置。

将框架包裹在父元素中以限制其尺寸：

<div class="container">
  <div id="box-camera"></div>
</div>
.container {
  width: 800px;
  height: 600px;
  position: relative;
}

保持适当的高宽比，使用户更容易将面部框入画面。

开发者工具调整大小

通过浏览器开发者模式调整屏幕大小的测试将无法正常工作。请直接调整浏览器窗口大小。

开始文件采集
步骤 1 — 实现 callback 对象

Web SDK 使用 callback 对象（传递给 open()）来处理成功和错误事件。两个处理程序均为必填项：

处理程序调用时机
on.success(obj)捕获成功完成——接收包含 base64 和 encrypted 的对象
on.error(error)会话期间发生错误——接收 ErrorBio
const callback = {
  on: {
    success: (obj) => {
      console.log(obj.base64);
      console.log(obj.encrypted);
    },
    error: (error) => {
      console.error(error);
    }
  }
};
强制回调

callback 对象是必填项。如果未正确实现（同时覆盖 success 和 error 事件），SDK 将抛出异常，若未处理该异常，将在用户的控制台中显示。

步骤 2 — 构建摄像头并准备文件会话

构建摄像头实例并调用 prepareDocumentCamera，传入 UnicoConfig 和所需的 DocumentCameraTypes：

const unicoCamera = unicoCameraBuilder.build();

const config = new UnicoConfig()
  .setHostname("<YOUR_HOSTNAME>")
  .setHostKey("<YOUR_HOST_KEY>");

unicoCamera.prepareDocumentCamera(
  config,
  DocumentCameraTypes.CNH
).then(cameraOpener => {
  cameraOpener.open(callback);
}).catch(error => {
  console.error(error);
});

有关完整的结果处理，请参阅接收结果。

最后更新 于