微信小程序

本页内容有帮助吗？

微信小程序

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

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

🤖 AI Prompt#

复制 AI 提示词，粘贴到 Codex、Copilot、Claude Code 等AI 编码工具，即可自动生成代码，完成 TD SDK 集成

1.2 小程序代码集成#

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

JavaScript

{
  "plugins": {
    "tdfp-plugin": {
      "version": "2.1.5",
      "provider": "wxc3b909c3d24c5417"
    }
  }
}

注意：三方框架可对应添加。如 uni-app，可在 manifest.json 文件的 mp-weixin 模块中添加上述声明

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

在 app.js 中partnerCode 为必要参数，appname和channel为可选字段：

JavaScript

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

3.获取 blackBox
设备指纹 SDK 采用类微信 API 的调用模式，支持传入 success、fail、complete 三个回调及其它配置字段。

在第一个页面加载时调用getInfo方法，进行数据异步更新，更新后可以在success回调内获取到blackBox

JavaScript

const plugin = requirePlugin('tdfp-plugin')
var that = this
var fmagent = new plugin.FMAgent(app.globalData._fmOpt) 
fmagent.getInfo({
  page: that, // 请传入 FMAgent 所在的 Page 或 Component 对象
  mode: 'plugin',
  openid: '', // 如果 openid 或者 unionid 为空或者 undefined，请勿加密上传，传空字符串即可
  // 如果您开通了 unionid 功能，请传入加密的用户 unionid，
  // 请传入加密的用户 openid(需保证加密后的 openid 与原始 openid 是一一对应关系)
  unionid: '', 
  success: function (res) {}, // 成功回调，res 为 blackBox 字符串
  fail: function (res) {}, // 失败回调，res 为各种 exception 对象
  complete: function (res) {} // 完成回调，res为blackbox字符串或者exception 对象
})

在需要同步获取blackBox的节点调用getInfoSync来获取blackBox。

说明：首次生成blackBox直接调用同步方法会生成降级的blackBox

JavaScript

var blackbox = fmagent.getInfoSync({
  openid: '',
  unionid: '',
})

注意：方法没有强制入参，openid和unionid强烈建议提供

设备指纹参数说明#

参数	类型	描述	示例	是否必传	是否移除
page	Object	当前所在的page对象或component对象	that	否
openid	string	加密后的用户openid（加密算法可以随意选择，请确保加密前后的一一对应关系，我们建议使用MD5或者SHA256）（切记不可以传自定义默认值，没有值请传空字符串，否则会导致碰撞）	ef54040ea9cb599823077	是
mode	string	当前对接模式（插件化接入请传入'plugin',sdk接入方式请忽略）	'plugin'	是
unionid	string	加密后的用户unionid（加密算法可以随意选择，请确保加密前后的一一对应关系，我们建议使用MD5或者SHA256）（切记不可以传自定义默认值，没有值请传空字符串，否则会导致碰撞）	ef54040ea9cb599823077	否
getInfoType	string	获取blackbox的模式（'1'：优先使用缓存的blackbox，'2'：优先使用实时采集的blackbox，'3'：优先使用未过期的blackbox至过期，默认模式为'1'）	'1'	否
timeout	Integer	获取blackbox超时（默认2500，包括采集和发送请求的总时长,范围：2500-16000，单位ms）	6000	否
getLocationAllowed	boolean	是否采集位置信息。如需采集位置信息，请联系运营获取隐私合规指导（默认false不采集，如需采集请提前获取微信及小程序的位置信息授权，且配置当前项为true）		否	latitude、longitude
success	function	获取成功回调	function(res)	是
fail	function	获取失败回调	function(res)	是
complete	function	获取完成回调	function(res)	否

注意：

blackbox存在有效期，所以请不要自行对blackbox做缓存，在我们SDK内部有缓存机制，所以请在需要blackbox的地方，调用getInfo接口即可
降级blackbox的长度在3000-5000字节，建议上报blackbox放在body中
如果需要sdk版本对接方式，请联系运营支持

本页内容有帮助吗？

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

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

🤖 AI Prompt#

复制 AI 提示词，粘贴到 Codex、Copilot、Claude Code 等AI 编码工具，即可自动生成代码，完成 TD SDK 集成

1.2 小程序代码集成#

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

JavaScript

{
  "plugins": {
    "tdfp-plugin": {
      "version": "2.1.5",
      "provider": "wxc3b909c3d24c5417"
    }
  }
}

注意：三方框架可对应添加。如 uni-app，可在 manifest.json 文件的 mp-weixin 模块中添加上述声明

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

在 app.js 中partnerCode 为必要参数，appname和channel为可选字段：

JavaScript

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

3.获取 blackBox
设备指纹 SDK 采用类微信 API 的调用模式，支持传入 success、fail、complete 三个回调及其它配置字段。

在第一个页面加载时调用getInfo方法，进行数据异步更新，更新后可以在success回调内获取到blackBox

JavaScript

const plugin = requirePlugin('tdfp-plugin')
var that = this
var fmagent = new plugin.FMAgent(app.globalData._fmOpt) 
fmagent.getInfo({
  page: that, // 请传入 FMAgent 所在的 Page 或 Component 对象
  mode: 'plugin',
  openid: '', // 如果 openid 或者 unionid 为空或者 undefined，请勿加密上传，传空字符串即可
  // 如果您开通了 unionid 功能，请传入加密的用户 unionid，
  // 请传入加密的用户 openid(需保证加密后的 openid 与原始 openid 是一一对应关系)
  unionid: '', 
  success: function (res) {}, // 成功回调，res 为 blackBox 字符串
  fail: function (res) {}, // 失败回调，res 为各种 exception 对象
  complete: function (res) {} // 完成回调，res为blackbox字符串或者exception 对象
})

在需要同步获取blackBox的节点调用getInfoSync来获取blackBox。

说明：首次生成blackBox直接调用同步方法会生成降级的blackBox

JavaScript

var blackbox = fmagent.getInfoSync({
  openid: '',
  unionid: '',
})

注意：方法没有强制入参，openid和unionid强烈建议提供

设备指纹参数说明#

参数	类型	描述	示例	是否必传	是否移除
page	Object	当前所在的page对象或component对象	that	否
openid	string	加密后的用户openid（加密算法可以随意选择，请确保加密前后的一一对应关系，我们建议使用MD5或者SHA256）（切记不可以传自定义默认值，没有值请传空字符串，否则会导致碰撞）	ef54040ea9cb599823077	是
mode	string	当前对接模式（插件化接入请传入'plugin',sdk接入方式请忽略）	'plugin'	是
unionid	string	加密后的用户unionid（加密算法可以随意选择，请确保加密前后的一一对应关系，我们建议使用MD5或者SHA256）（切记不可以传自定义默认值，没有值请传空字符串，否则会导致碰撞）	ef54040ea9cb599823077	否
getInfoType	string	获取blackbox的模式（'1'：优先使用缓存的blackbox，'2'：优先使用实时采集的blackbox，'3'：优先使用未过期的blackbox至过期，默认模式为'1'）	'1'	否
timeout	Integer	获取blackbox超时（默认2500，包括采集和发送请求的总时长,范围：2500-16000，单位ms）	6000	否
getLocationAllowed	boolean	是否采集位置信息。如需采集位置信息，请联系运营获取隐私合规指导（默认false不采集，如需采集请提前获取微信及小程序的位置信息授权，且配置当前项为true）		否	latitude、longitude
success	function	获取成功回调	function(res)	是
fail	function	获取失败回调	function(res)	是
complete	function	获取完成回调	function(res)	否

注意：

blackbox存在有效期，所以请不要自行对blackbox做缓存，在我们SDK内部有缓存机制，所以请在需要blackbox的地方，调用getInfo接口即可
降级blackbox的长度在3000-5000字节，建议上报blackbox放在body中
如果需要sdk版本对接方式，请联系运营支持