企业微信H5应用相关知识点汇总(入门向)

以下内容如果没有实际开发过可能会看不懂 没关系 当你开发后遇到问题再回过头看看 可能会对你有所帮助
官方文档 请认真阅读官方文档. 本文只做些许补充 主要以记录为主
前提摘要: 文中提及的 微信指的是我们正常使用 绿色logo的 微信客户端
企微指的是白色logo的 企业微信客户端

1.jsapi_ticket

jsapi_ticket作为后端生成签名的参数 后端开发文档分为企业的和应用的两种
wx.config 是使用企业的
wx.agentConfig是使用应用的
后端需要出2个接口提供给前端使用


2.jweixin的版本号

官方文档中
微信环境的版本号是1.6.0 企微的版本号是1.2.0
虽然我没找到有何不同 但是最好是按照文档的要求去使用 官方文档只提供了script标签引入的方法
可以npm 安装依赖包 引入使用
1.6.0的使用weixin-js-sdk
1.2.0 的使用weixin-jweixin


3.签名算法验证工具

微信 JS 接口签名校验工具
上面链接为测试wx.config中签名的工具 如果wx.config返回错误 可以自行检查wx.config的参数是否正确
反之也可以测试wx.agentConfig
应用的签名校验工具 <<<这个我本人没测试过 后端提供给我的


4.应用管理 配置文件

当你需要使用wx相关api的时候,需要配置白名单域名 否则无法使用

(每次都要发测试环境去开发代码.基本都属于盲写阶段 对git提交非常不友好 后面会提及)
如果有大佬知道如何开发环境联调 烦请留言 谢谢.


首先可以通过企微pc端左上角(点击头像->管理企业)
跳转到网页地址后 点击应用管理 ->选择自建的应用->开发者接口 配置可信域名 不需要二级路径和协议名 并且联系运维在根路径放置配置文件

5.API调用

企微api相关使用 目前是直接在手机上扫码测试的
小程序开发者工具里使用公众号开发的环境 很多api是无法调用的 需要注意

错误码查询工具
本人上传了官方1.2.0的jweixin npm包 weixin-jweixin

企业微信官方 js-sdk1.2.0 es6 版本 (非1.6.0微信版本) 说明: 仅将官方 js-sdk 发布到 npm,便于 webpack 使用 注意事项:此包为企业微信wx.config相关api所需的依赖包 如需使用wx.agentConfig注入应用权限请使用其他依赖包

ps: 如需安装jwxwork-1.0.0.js 配合使用 可以使用wecomjsdk这个包
或者引入js


注意!!! 如果使用script标签引入jwxwork 配合weixin-jweixin依赖包使用的话 在android企微中和PC端企微中会不识别jwxwork相关api . IOS是正常的注意!!!

安装:npm install weixin-jweixin -S
安装:npm install wecomjsdk -S

由于wx变量重名问题 Object.assigon 也会导致jwxwork.api为undefined 所以这里讨巧解决
// 这里的引入顺序不能替换 否则会报错
// 不使用script标签引入的原因是 企微pc端和部分android机器会不识别jwxwork-1.0.0.js
import wx from 'wecomjsdk'; // 由于这个包的开发者使用的是module.exports导出的 
// 所以不能使用 xx as xx 去重命名如有需要可以使用CommonJS方法
// const wxx = require('wecomjsdk') 
import {default as jwx} from 'weixin-jweixin'  // 解构default 重命名为jwx

methods(){
  const share_url = encodeURIComponent(location.href.split('#')[0]) // 获取当前项目url
  //TODO: 调用企业和应用的相关接口获取签名、企业ID、应用ID等相关信息
  const res = '企业相关数据'
  const response = '应用相关数据'
  const {corpId,nonceStr,signature,timestamp} = res;
  jwx.config({
        beta: true, // 必须这么写,否则wx.invoke调用形式的jsapi会有问题
        debug: process.env.NODE_ENV === 'development', // 开启调试模式,调用的所有api的返回值会在客户端alert出来,若要查看传入的参数,可以    在pc端打开,参数信息会通过log打出,仅在pc端时才会打印。
        appId: corpId, // 必填,企微的corpID
        timestamp: timestamp, // 必填,生成签名的时间戳
        nonceStr: nonceStr, // 必填,生成签名的随机串
        signature: signature, // 必填,签名,见附录1
        jsApiList: [
          'selectExternalContact',
          'shareAppMessage'
        ], // 必填,需要使用的JS接口列表,
  });
  // 配置成功后在回调里处理企微agentConfig
  jwx.ready(()=>{
    wx.agentConfig({
        corpid: corpId,
        agentid: response.data.agentId,
        timestamp: response.data.timestamp, 
        nonceStr: response.data.nonceStr, 
        signature: response.data.signature,
        jsApiList: [
          'sendChatMessage', // https://developer.work.weixin.qq.com/document/path/94349
          'setShareAttr', // https://developer.work.weixin.qq.com/document/path/94486#setShareAttr
          'getContext', // https://developer.work.weixin.qq.com/document/path/94315#21950
        ],
        success: function(res) {
          console.log('应用成功',res)
        },
        fail: function(res) {
          console.log('应用失败',res)
          if(res.errMsg.indexOf('function not exist') > -1){
              alert('版本过低请升级')
          }
        }
    });
  })
}

后续页面可以通过jwx调用config---jsApiList的方法
wx调用agentConfig---jsApiList的方法

wx.invoke ....
jwx.scanQRCode...


6. 测试环境发布

由于微信和企微的相关api都需要在各自的环境使用 请注意使用userAgent判断wxwork字段
并且微信验证url白名单 导致必须盲写然后提交代码到测试环境才可以测试代码完整度
可以使用git rebase 合并提交记录 此文不做赘述


7.网页授权登录

网页授权的相关文档不在客户端API中... 在服务端API中....orz
找了好久没找到 还以为企业微信不支持登录呢
企业微信网页授权登录文档
需要注意的是 回调地址需要在 开发者接口--->网页授权及JS-SDK--->可作为应用OAuth2.0网页授权功能的回调域名中配置回调域名
并且只能填写一个域名.. 如何区分测试环境和产线环境目前不清楚 ...初步方案是建设2个应用


8.客户相关API调用的权限问题

之前为了兼容测试环境和产线环境开了两个应用
结果发布产线以后 客户相关的wx.api 都无法调用 后续排查下来是没有配置客户权限(一开始以为是apiList的权限相关接口配置出问题了)

Snipaste_2022-08-19_09-33-31.png

点击API后有个可调用应用 需要把相关应用勾选上.

未完待续...

你可能感兴趣的:(企业微信H5应用相关知识点汇总(入门向))