设备指纹WEAPP(微信/QQ/字节跳动/支付宝小程序)sdk接入手册#

以下以微信示例,其他小程序和微信小程序使用方式基本一致,可以参照下述例子使用

导入SDK文件#

将产出js文件拷贝到小程序的libs目录

初始化#

正常使用:在app.js 引入如下所示代码:

const SMSdk = require('./libs/weapp-fp'); // 注意:require之后要立即初始化配置
// 更多参数请看下一章节详细说明
// 若需要采集openId,和unionId则在wx.login()后获取到openId 和unionId。再进行SMSdk.initConf() 初始化操作。
SMSdk.initConf({
// 1. 通用配置项
organization: 'xxxxxxx', // 必填,公司标识,邮件中organization项
publicKey: 'xxxxxxx', // publicKey是v3.0.0版本后必填项,是加密公钥,邮件中publicKey项
// 2.连接海外机房特殊配置项,仅供设备数据上报海外机房客户使用
// 2.1 业务机房在国内
// 1) 用户分布:国内(默认设置)
// apiHost:'fp-it.fengkongcloud.com'
// 2) 用户分布:全球
// apiHost:'fp-it-acc.fengkongcloud.com'
// 2.2 业务机房在欧美(弗吉尼亚)
// 1) 用户分布:欧美
// apiHost: 'fp-na-it.fengkongcloud.com'
// 2) 用户分布:全球
// apiHost: 'fp-na-it-acc.fengkongcloud.com'
// 2.3 业务机房在欧美(法兰克福)
// apiHost: 'api-device-eur.fengkongcloud.com'
// 2.4 业务机房在东南亚
// 1) 用户分布:东南亚
// apiHost:'fp-sa-it.fengkongcloud.com'
// 2) 用户分布:全球
// apiHost:'fp-sa-it-acc.fengkongcloud.com'
// 2.5 私有化特殊配置的服务端接口域名
// apiHost: 'xxxxxx'; // 私有化部署的服务域名
});
App({
/**
* Global shared
* 可以定义任何成员,用于在整个应用中共享
*/
data: {},
/**
* 注入数美SMSdk方法,后续页面可以引入
*/
SMSdk: SMSdk,
/**
* 生命周期函数--监听小程序初始化
* 当小程序初始化完成时,会触发 onLaunch(全局只触发一次)
*/
onLaunch() {
}
});

采集openId和unionId#

为了保证设备标识稳定性及风险识别能力,需要您将openId和unionId通过配置传递给我们。具体接入方式如下:

1、在wx.login()后,将获取到的res.code传给后端获取对应的openId,unionId

2、将获取到openId 和unionId。调用SMSdk.setOpenId SMSdk.setUnionId 进行配置

3、进行SMSdk.initConf() 初始化操作。

SMSdk.setOpenId('您获取到的openId');
SMSdk.setUnionId('您获取到的UnionId');
SMSdk.initConf({}); // 同正常初始化接入

使用设备标识#

// 首先获取数美设备指纹sdk对象
const {SMSdk} = getApp();
Page({
data: {
deviceId: '',
},
/**
* 方式一 可以在自定义的方法中调用smSdk.getDeviceId获取数据,该方法返回一个Promise对象,所以可以通过async/await语法获取设备指纹
*/
async fetchData() {
const deviceId = await SMSdk.getDeviceId();
// 后面是业务代码
// ...
},
/**
* 方式二 SMSdk.getDeviceId方法在初始化之后即可调用
* 例如 可以在onReady生命周期函数中调用,也可以在小程序其他生命周期中调用
*/
onReady() {
SMSdk.getDeviceId().then(deviceId => {
this.setData({ deviceId });
});
},
});

注意事项#

1、小程序开发管理需要将服务端域名添加到白名单中,如果私有化配置了apiHost,需要将这个私有化自定义域名加白。

2、设备指纹sdk支持在跨端框架taro2/3 中集成使用,不过注意在taro2框架中需要将sdk从编译中排除,在taro2框架的config中如下配置即可。

mini: {
compile: {
exclude: [
function (modulePath) {
return modulePath.indexOf('fp-wx.min') >= 0
},
],
},
},

参数#

字段参数类型是否必填默认值字段说明
organizationstring数美分配的公司标识,数美后台可以查看看
publicKeystring私钥标识,邮件中publicKey项
apiProtocolstringhttps如果使用http,则设置成 http
apiHoststringfp-it.fengkongcloud.com数据上报的域名,详见APIHOST枚举值,然后微信账号下要将域名设置到白名单中,例如 https://fp-it.fengkongcloud.com/

APIHOST枚举值#

业务机房所在区域用户分布apiHost值
国内国内(默认设置)fp-it.fengkongcloud.com
国内全球fp-it-acc.fengkongcloud.com
欧美(弗吉尼亚)欧美fp-na-it.fengkongcloud.com
欧美(弗吉尼亚)全球fp-na-it-acc.fengkongcloud.com
欧美(法兰克福)-api-device-eur.fengkongcloud.com
东南亚东南亚fp-sa-it.fengkongcloud.com
东南亚全球fp-sa-it-acc.fengkongcloud.com

获取deviceId的方法#

方法名参数返回值说明
getDeviceIdPromise异步方法,返回一个 promise,以便在未来某个时候把deviceId交给使用者。该方法可以在初始化之后需要的地方都可以调用

采集openId,unionId的方法#

方法名参数返回值说明
setOpenIdstring将登录后获取的openId加入采集
setUnionIdstring将登录后获取的unionId加入采集

在线咨询