H5人脸认证
接口说明
[!NOTE]
君子签提供单独的H5人脸识别服务,该接口主要用于个人进行人脸识别,确保是否是本人。该接口涉及到人脸识别费用,如果未购买需要联系商务进行购买。注:获取到人脸URL地址后,链接地址有效期30分钟,一个链接只能打开一次,不管是否验证再次打开同一链接则失效,需要重新获取新的人脸URL地址。
http请求方式
[!NOTE]
POST application/x-www-form-urlencoded
http请求地址
[!NOTE]
$SERVICE_URL/v2/auth/startH5Face #其中$SERVICE_URL为生产或测试的地址
http请求参数
除公共必填参数外,还需要传以下参数
参数 | 类型 | 是否必填 | 默认值 | 说明 |
---|---|---|---|---|
orderNo | string | * | 订单号,最大支持32个字符 | |
name | string | * | 姓名 | |
identityCard | string | * | 身份证号 | |
backUrl | string | * | 同步回调地址 | |
startFrom | int | * | 启动方式1=browser :表示在浏览器启动刷脸,2=app :表示在 app 里启动刷脸,默认值为browser | |
notifyUrl | string | ? | 人脸结果异步通知地址 | |
useCustomDomain | string | ? | 1 使用自定义域名(注:嵌入小程序推荐设置该参数) |
代码实现
JAVA实现
RequestUtils requestUtils=RequestUtils.init(SERVICE_URL,APP_KEY,APP_SECRET);//建议生成为spring bean
//构建请求参数
Map<String,Object> params=new HashMap<>();
params.put("orderNo","XXXXXXXXXXX");//
params.put("name","易凡翔");//
params.put("identityCard","50024XXXXXXXXXX");//
params.put("backUrl","http://xxx.xx.xx");//
ResultInfo<Void> ri= requestUtils.doPost("/v2/auth/startH5Face",params);
PHP实现
//构建请求工具
$requestUtils=new RequestUtils($serviceUrl, $appkey, $appSecret);
//初始化合同参数
$request=array(
"orderNo" => "XXXXXXXXXXX",
"name" => "易XX",
"identityCard" => "50024019XXXXXXXXXX",
"backUrl" =>"http://xxx.xx.xx"//启动方式1=browser :表示在浏览器启动刷2=app :表示在 app 里启动刷脸 默认值为browser
//"startFrom" => 1
);
//发起请求
$response=$requestUtils->doPost("/v2/auth/startH5Face",$request);
http返回参数
[!NOTE]
返回response为application/json的数据,其字段说明如下
参数 | 类型 | 是否必返回 | 说明 |
---|---|---|---|
success | bool | * | 成功true;异常false |
msg | string | ? | 异常时,返回异常原因 |
resultCode | string | ? | 异常时返回 |
data | object | ? | 业务信息 |
[!NOTE]
data为JSON对象,参考:
参数 | 类型 | 是否必返回 | 说明 |
---|---|---|---|
startFaceUrl | string | * | 人脸验证启动url (长连接) |
startFaceShortUrl | string | * | 人脸验证启动url (短链接) |
[!NOTE]
返回结果,参考:
//正确响应:
{"data":{"startFaceUrl":"https://XX.XXXX.XXX/api/....","startFaceShortUrl":"https://XX.XXXX.XXX/api/...."},"success":true}
//错误响应:
{"msg":"3-姓名或身份证不合法","resultCode":"BUSINESS_ERROR","success":false}