aliSmilePay

立即使用

概述

此模块封装了支付宝刷脸付中的客户端人脸识别sdk。

接入支付宝刷脸付需要在支付宝开放平台创建应用并通过审核,具体请查看支付宝刷脸付集成文档

硬件要求

“刷脸付”软件应用需要部署在带有指定 3D 摄像头并且通过蚂蚁验证的硬件设备上(以下称为 IOT 刷脸设备)才可正常使用。

  • 如果您已有 IOT 刷脸设备,则可在签约“刷脸付”之后,找技术服务同学咨询集成的操作流程;
  • 如果您目前没有IOT刷脸设备,可点击 自助收银机具介绍 以及 智能售卖机具介绍 下载附件,直接联系厂商进行购买;
  • 如果您是设备厂商,可参考 刷脸付设备入驻流程
    • 申请成为蚂蚁 IOT 刷脸设备提供商。

刷脸付流程

  • 获取刷脸所需的设备信息(模块接口:zolozGetMetaInfo)
  • 刷脸初始化(调用接口在服务端实现)
  • 唤起人脸识别(模块接口:zolozVerify)
  • 查询接口得到UID(调用接口在服务端实现)
  • 调用收单接口完成支付(调用接口在服务端实现)

zolozGetMetaInfo

采集刷脸所需的设备信息并完成刷脸的准备工作。如果返回成功结果,则请求商户服务端调用支付宝开放平台的人脸初始化接口。

zolozGetMetaInfo(params, callback(ret))

params

merchantId:

  • 类型:字符串类型
  • 描述:签约商户的pid。以2088开头

partnerId:

  • 类型:字符串类型
  • 描述:(可选项) ISV的pid。对于自用型商户,填写签约商户的pid,和merchantId保持一致

appId:

  • 类型:字符串类型
  • 描述:(可选项) 支付宝分配给开发者的应用ID,和当面付请求的appid保持一致。

deviceNum:

  • 类型:字符串类型
  • 描述:商户机具终端编号,和当面付请求的terminal_id 保持一致

storeCode:

  • 类型:字符串类型
  • 描述:(可选项)商户门店编号,和当面付请求的store_id保持一致。

alipayStoreCode:

  • 类型:字符串类型
  • 描述: (可选项) 支付宝内部门店编号,和当面付请求中的alipay_store_id保持一致

extPar:

  • 类型:Json对象类型
  • 描述: (可选项) 其他参数,name为key,value为value

callback(ret,err)

ret:

  • 类型:JSON对象
  • 描述:正确返回
  • 内部字段:
{status:,          //布尔类型;是否添加成功
metaInfo:,                //字符串类型,此参数需要给服务端做刷脸初始化。内部字段:apdidToken/设备指纹,appName/应用名称,appVersion/应用版本,bioMetaInfo/生物信息,osVersion/系统版本,machineInfo/设备硬件相关信息,merchantInfo/商户相关信息,remoteLogID/刷脸调用的事务ID,extInfo/扩展参数,用于商户服务端传入信息
}

err:

  • 类型:JSON对象
  • 描述:错误返回
  • 内部字段:
{
code:''                //字符串类型;返回码;1000/调用成功,1003/用户选择退出,1004/超时,1005/用户选用其他支付方式
}

示例代码

var aliSmilePay = api.require('aliSmilePay');
aliSmilePay.zolozGetMetaInfo({
merchantId:'',
partnerId:'',
appId:'',
deviceNum:'',
storeCode:'',
alipayStoreCode:'',
}, function(ret,err) {
    alert(ret);
});

可用性

android系统

可提供的1.0.0及更高版本

zolozVerify

唤起人脸识别。如果认证成功,将返回一个ftoken。该ftoken用于后续查询被认证用户的信息

zolozVerify(params, callback(ret))

params

zimId:

  • 类型:字符串类型
  • 描述:刷脸付token,根据zolozGetMetaInfo接口返回的数据从服务端获取得到

protocal:

  • 类型:字符串类型
  • 描述:刷脸付协议。根据zolozGetMetaInfo接口返回的数据从服务端获取得到

smileMode:

  • 类型:数字类型
  • 描述:(可选项)指定选择刷脸模式,0:主屏幕显示;1:双面屏机具,副屏幕显示
  • 默认:0

callback(ret,err)

ret:

  • 类型:JSON对象
  • 描述:正确返回
  • 内部字段:
{status:,          //布尔类型;是否添加成功
fToken:‘’,                //字符串类型,用来支付或完成其他操作
subCode:‘’,                //字符串类型,二级返回码
msg:‘’,                //字符串类型,返回信息
result:{           //Json对象类型;
    alipayUid:'',      //字符串类型;支付宝账户的uid,这个UID是客户端接口返回的结果,并不安全。如果需要依赖UID进行业务决策,请不要使用这个UID数据。请通过服务端ftoken查询接口(query)得到可信的UID
}
}

err:

  • 类型:JSON对象
  • 描述:错误返回
  • 内部字段:
{
code:''                //字符串类型;返回码;1000/调用成功,1003/用户选择退出,1004/超时,1005/用户选用其他支付方式
}

示例代码

var aliSmilePay = api.require('aliSmilePay');
aliSmilePay.zolozVerify({
zimId:'',
protocal:'',
}, function(ret,err) {
    alert(ret);
});

可用性

android系统

可提供的1.0.0及更高版本