API Reference
English

微信小程序

1.1 小程序管理后台添加插件

  1. 登录微信公众平台,点击左侧下方设置菜单
  2. 进入设置页面,点击第三方设置标签页
  3. 插件管理模块中,点击添加插件按钮
  4. 搜索 wxfp ,选择插件,然后完成添加(若较紧急,可联系开发人员快速通过审批)

1.2 小程序代码集成

1.小程序app.json 里声明插件

{
  "plugins": {
    "tdfp-plugin": {
      "version": "2.0.0",
      "provider": "wxc3b909c3d24c5417"
    }
  }
}
  • 注意 :三方框架可对应添加。如 uni-app,可在 manifest.json 文件的 mp-weixin 模块中添加上述声明

2.引用插件 &&必要的配置

app.jspartnerCodeappKey 为必要参数,appnamechannel为可选字段:

const plugin = requirePlugin('tdfp-plugin')
App({
  ......
  globalData: {
    ......
    _fmOpt: {
      appKey:"", // 请填入你的appKey
      partnerCode: "", // 请填入您的partner code
      appName: "", // 请填入您的app name 同一个公司的不同小程序请填入不同的AppName
      channel: "", // 请填入您的channel
    }
  },
  onLaunch(){
    let fmagent = new plugin.FMAgent(this.globalData._fmOpt)
    fmagent.init()
  }
  ......
})

3.获取 blackBox
设备指纹 SDK 采用类微信 API 的调用模式,支持传入 successfailcomplete 三个回调及其它配置字段:其中openid和unionid为非必传参数

const plugin = requirePlugin('tdfp-plugin')
var fmagent = new plugin.FMAgent(app.globalData._fmOpt) 
fmagent.getDeviceInfo({
  openid:'',
  unionid:'',
  mode:'plugin',
}).then(function(result){
  if(result.apiStatus.code === 0) {
    var anonymousId = result.anonymousId;
    var blackBox = result.blackBox; 
    var fpVersion = result.fpVersion;
    var deviceRiskScore = result.deviceRiskScore;
    var sealedResult = result.sealedResult;
    var message = result.apiStatus.message;  
  } else {
    var code = result.apiStatus.code;
    var message = result.apiStatus.message;
  }
})

说明

响应结果

字段描述
anonymousId设备匿名ID,设备标识
blackBox设备信息查询标识)
fpVersionSDK版本号
deviceRiskScore当前设备风险分
sealedResult加密的设备信息,二进制 Base64 编码字符串,仅在客户端密封结果开启时返回,解密结果与设备信息查询获取的信息一致

状态信息定义

sdk返回的状态码对应的信息说明

codemessage备注
0Success成功
1001SDK errsdk发生异常
1002Network error网络错误
1003API err后端接口返回错误
1004Traffic limit网关限流
1100Unknown error未知错误