H5活体检测JS SDK说明文档

• 1.简介
• 2.JS SDk内部原理与调用流程
• 3.JS SDK与其他公有云接口配合使用
• 4.兼容性检测
• 5.更新日志

1.简介

H5活体检测JS SDK是一个在浏览器端进行活体检测和静默活体检测的Web UI组件。它通过浏览器进行视频采集，然后访问Linkface公有云接口进行检测并返回检测结果。

2.JS SDk内部原理与调用流程

3.JS SDK与其他公有云接口配合使用

当客户需要JS SDK与其他公有云接口配合使用，完成某些业务场景，比如通过JS SDK配合selfie_idnumber_verification接口完成人身比对的业务场景。

首先要强调，在JS SDK中调用了四个接口，分别是/liveness/check_liveness、/liveness/check_silent_liveness、/hackness/selfie_hack_detect和/liveness/liveness_image，为了方便说明，将这四个接口统称为js sdk调用接口。与js sdk配合使用的其他接口，也就是除js sdk调用接口之外的接口，称之为业务接口。

不配置代理服务器时的调用流程与注意点

调用流程图：

注意点：

1. 在①处调用的接口就是客户平常所定义的接口，没有要特别注意的地方，通过这些接口调用linkface的公有云业务接口。
2. 在②处定义的接口需要特别注意，后端定义的接口名称必须与js sdk调用接口的名称相同，并且接口的入参必须与linkface公有云文档中相应的接口入参相同。
3. 调用new Liveness()时，host配置项对应客户后端服务器地址。

配置代理服务器时的调用流程与注意点

调用流程图：

注意点：

1. 在①处所调用的客户自定义接口去调用linkface的公有云业务接口。
2. 在②处调用客户代理服务器，配置代理服务器的原因与方法请参考：H5配置代理服务器
3. 调用new Liveness()时，host配置项对应客户代理服务器地址。

建议客户使用第二种配置代理服务器的方式。

4.兼容性检测

我们对IOS和Android各种主流机型下主流浏览器进行了兼容性测试，由于Android机型和各种类型的手机浏览器过于庞大，所以无法覆盖所有机器的所有浏览器，只能给出不兼容JS SDK的黑名单。

用户也可以用全局对象Liveness的静态属性isAvailable来检测当前浏览器是否支持活体检测JS SDK，false为当前浏览器不支持，true为当前浏览器支持或者没有被测试覆盖。

  if (Liveness.isAvailable) {
    // 进行活体检测
  } else {
    // 提示不支持当前浏览器
  }

5. 更新日志