使用指南

说明

本文档适用于 JS SDK 2.0.0

链接地址

demo页:https://h5sdk.linkface.cn/#/home

活体检测页:https://h5sdk.linkface.cn/#/liveness_check

demo 页

该页面是一个完整的活体检测流程演示页,仅供参考,您在实际开发中不应跳转到该页。

demo 页配置项

您需要通过跳转时传参,来配置相关信息。

例如:https://h5sdk.linkface.cn/#/home?api_id=YOUR_API_ID&timestamp=YOUR_TIME_STAMP&sign=YOUR_SIGN

参数名称 是否可空 默认值 说明
api_id 您的api_id
timestamp 您在生成签名时所用的时间戳
sign 签名 (api_id+api_secret+timestamp) 使用SHA256算法获取

活体检测页

您在需要活体检测服务时,需要跳转到该页面,在活体检测流程成功或者失败时,会跳转到您所配置的页面,并附带image_id。(例如:https://wwww.YOUR_LINK.com/?image_id=IMAGE_ID)您可以通过调用 /liveness/liveness_image 接口来获取活体检测结果图片。

活体检测页配置项

您需要通过跳转时传参,来配置相关信息。

例如:https://h5sdk.linkface.cn/#/liveness_check?api_id=YOUR_API_ID&timestamp=YOUR_TIME_STAMP&sign=YOUR_SIGN&mode=VIDEO&motion=BLINK&fail_count=3&failed_url=YOUR_FAILED_URL&success_url=YOUR_SUCCESS_URL

参数名称 是否可空 默认值 说明
api_id 您的api_id
timestamp 您在生成签名时所用的时间戳
sign 签名 (api_id+api_secret+timestamp) 使用SHA256算法获取
mode 活体检测采集模式,可为['IMAGE', 'VIDEO']
motion 采集模式为 VIDEO 时生效且为不可为空 活体检测录制动作,可为['BLINK', 'MOUTH', 'YAW', 'NOD']
fail_count 3 用户活体检测失败达到该次数后,开放退出活体检测并跳转到失败 url 入口
failed_url 检测失败后超过指定次数后,页面重定向的地址, image_id通过url带入(若有)
success_url 检测成功后,页面的重定向地址,image_id通过url带入

生成签名

签名需要通过使用 SHA256 加密 api_id+api_secret+timestamp 获得,示例如下:

import sha256 from 'crypto-js/sha256'

const api_id = 'YOUR_API_ID'
const api_secret = 'YOUR_API_SECRET'
const timestamp = Date.now()
// 1611821716285

const sign = sha256(api_id + api_secret + timestamp).toString()
// 80b293396c840e842500a067c6494c2ea0bed9d13cec90980f852f61c8b585c3

上传视频限制

我们这里对用户上传的视频进行了大小和时间上的限制,大小限制是35M,时间限制是5s。

注意事项

如果用户在录制完成后,防 hack 模型检测判断为假人的时候,会给用户返回「图片效果不佳」。

results matching ""

    No results matching ""