微信开放标签使用 ---微信h5浏览器唤起app以及小程序

3,087 阅读6分钟

微信开放标签实现微信浏览器内H5页面唤起微信小程序或者APP,DEMO页链接 微信开放标签官方文档

注意事项

  • 微信开放标签有最低的微信版本要求,以及最低的系统版本要求。
    微信版本要求为:7.0.12及以上。 系统版本要求为:iOS 10.3及以上、Android 5.0及以上。

开放标签使用步骤

微信开放标签使用步骤与微信JS-SDK类似,也需要引入JS文件等步骤。如果是公众号身份的网页,需要绑定安全域名,如果是使用小程序云开发静态网站托管的小程序网页,则不需绑定安全域名即可直接使用(即跳过下面"步骤一:绑定安全域名")。

步骤一:绑定域名

登录微信公众平台进入“公众号设置”的“功能设置”里填写“JS接口安全域名”。

步骤二:引入JS文件

在需要调用JS接口的页面引入如下JS文件:res.wx.qq.com/open/js/jwe… (支持https)

如需进一步提升服务稳定性,当上述资源不可访问时,可改访问:res2.wx.qq.com/open/js/jwe… (支持https)

备注:支持使用 AMD/CMD 标准模块加载方法加载。

步骤三:通过config接口注入权限验证配置并申请所需开放标签

与使用JS-SDK配置方式相同,所有需要使用开放标签的页面必须先注入配置信息,并通过openTagList字段申请所需要的开放标签,否则将无法使用(同一个url仅需调用一次)。开放标签的申请和JS接口的申请相互独立,因此是可以同时申请的。

拿到相关appId以及微信签名后通过config接口注入权限验证配置

  • 其中可以通过ready接口处理成功验证,通过error接口处理失败验证

    window.wx.config({ debug: true, // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以在pc端打开,参数信息会通过log打出,仅在pc端时才会打印 appId: appId, // 必填,公众号的唯一标识 timestamp: timestamp, // 必填,生成签名的时间戳 nonceStr: nonce, // 必填,生成签名的随机串 signature: signature, // 必填,签名 jsApiList: [ "onMenuShareTimeline", // 分享到朋友圈 ], // 必填,需要使用的JS接口列表 openTagList: ["wx-open-launch-weapp", "wx-open-launch-app"], // 可选,需要使用的开放标签列表 }); //通过ready接口处理成功验证 window.wx.ready(() => { console.log("ok", "wx-ready===========");
    //config信息验证后会执行ready方法,所有接口调用都必须在config接口获得结果之后,config是一个客户端的异步操作,所以如果需要在页面加载时就调用相关接口,则须把相关接口放在ready函数中调用来确保正确执行。对于用户触发时才调用的接口,则可以直接调用,不需要放在ready函数中 }); // 通过error接口处理失败验证 window.wx.error((err) => { console.log(err, "wx-err==========="); // config信息验证失败会执行error函数,如签名过期导致验证失败,具体错误信息可以打开config的debug模式查看,也可以在返回的res参数中查看,对于SPA可以在这里更新签名 });

小程序跳转按钮(开放标签说明):
  • 用于页面中提供一个可跳转指定小程序的按钮。使用此标签后,用户需在网页内点击标签按钮方可跳转小程序
  • 此功能的开放对象:
  1. 已认证的服务号,服务号绑定“JS接口安全域名”下的网页可使用此标签跳转任意合法合规的小程序。
  2. 已认证的非个人主体的小程序,使用小程序云开发的静态网站托管绑定的域名下的网页,可以使用此标签跳转任意合法合规的小程序。
  • 其中属性username是所需跳转的小程序原始id,即小程序对应的以gh_开头的,为必填项

  • 其中属性path是所需跳转的小程序内页面路径及参数,注意:所声明的页面路径必须添加 .html后缀,如pages/home/index.html

相关html代码
<div style="width: 750px; height: 200px;">
    <wx-open-launch-weapp
      id="launch-btn01"
      username="gh_6718e48f289e"
      path="pages/index/index.html"
    >
      <template>
        <button  style="color: #666;width: 50px;height: 50px;display: block;text-align: center;" class="wx-btn wx-btn01" >
          跳转小程序
        </button>
      </template>
    </wx-open-launch-weapp>
</div>
事件
  • ready------标签初始化完毕,可以进行点击操作

  • launch------用户点击跳转按钮并对确认弹窗进行操作后触发

  • error------用户点击跳转按钮后出现错误(有返回值{ errMsg: string };errMsg值为launch:fail时,跳转失败)

相关js代码
// 调起成功回调
launchBtn01.addEventListener("launch", (e) => {
  console.log(e, "launch1--eee=========");
});
 // 调起失败回调
launchBtn01.addEventListener("error", (e) => {
  console.log(e.detail, "launch1---fail----------------");
});
App跳转按钮(开放标签说明):
  • 用于页面中提供一个可跳转指定App的按钮。此功能仅开放给已认证的服务号,在使用该标签之前,首先需要前往微信开放平台的管理中心-公众账号或小程序详情-接口信息-网页跳转移动应用-关联设置中绑定所需要跳转的App。详细配置规则参考文档《微信内网页跳转APP功能》
  • 其中属性appid是所需跳转的AppID,是第三方sdk申请的,为必填项
  • 其中属性extinfo是跳转所需额外信息(url参数等)
相关html代码
<div style="width: 750px; height: 200px;">
    <wx-open-launch-app
      id="launch-btn02"
      appid="wx6870fe2aa6a6b9cd"
      extinfo=""
    >
      <template>
        <button
          style=" color: #666;width: 200px;height: 160px; display: block; text-align: center;"
          class="wx-btn wx-btn02"
        >
          跳转App
        </button>
      </template>
    </wx-open-launch-app>
</div>
相关js代码
// 调起成功回调
launchBtn02.addEventListener("launch", (e) => {
  console.log(e, "launch2--eee=========");
});
 // 调起失败回调
launchBtn02.addEventListener("error", (e) => {
  console.log(e.detail, "launch2---fail----------------");
});
事件
  • ready------标签初始化完毕,可以进行点击操作

  • launch------用户点击跳转按钮并对确认弹窗进行操作后触发

  • error------用户点击跳转按钮后出现错误(有返回值{ errMsg: string };errMsg值为launch:fail时,说明调⽤失败,或安卓上该应用未安装,或iOS上用户在弹窗上点击确认但该应⽤未安装;errMsg值为"launch:fail_check fail"时,说明校验App跳转权限失败,请确认是否正确绑定AppID)

踩坑

  • 必须放在服务器,配置成功之后,必须要在真机下按钮才会显示,试错成本略高
  • 微信网页跳转app时,安卓手机点击按钮后出现提示“即将离开微信,打开程序”,点击允许后,无跳转反应,无错误反馈,根据微信开放平台技术提供方案原因是安卓包需要按照文档配置,麻烦相关安卓开发同事协助配置发生产包,配置文档链接:Android接入指南 配置