自建 H5 应用接入企业微信 JDK(WECOM-JSSDK)以实现好友添加功能
要将自建的 H5 应用接入企业微信 JSSDK,并实现好友添加功能,你需要按照以下步骤进行:
前提条件
- 企业微信的开发者账号:确保你已经注册了企业微信,并获得了相应的开发权限。
- 企业微信应用设置:确保你的应用已在企业微信管理后台创建,并拥有相关接口的权限。
步骤一:配置企业微信应用
- 获取企业ID和应用ID:登录企业微信管理后台,找到你创建的应用,记录下企业ID和AgentId(应用ID)。
- 设置可信域名:在企业微信管理后台-> 应用设置 -> 开发管理中配置可信域名,确保你的H5应用所部署的域名已被添加到可信域名列表中。
步骤二:获取Access Token
在服务器端使用企业微信提供的接口获取Access Token。Access Token用于调用企业内部API。
调用接口:
GET https://qyapi.weixin.qq.com/cgi-bin/gettoken?corpid=企业ID&corpsecret=应用Secret
步骤三:生成JSSDK签名
获取jsapi_ticket: 使用Access Token调用以下接口:
GET https://qyapi.weixin.qq.com/cgi-bin/get_jsapi_ticket?access_token=ACCESS_TOKEN
生成签名: 使用jsapi_ticket、noncestr(随机字符串)、timestamp(时间戳),以及当前网页的URL,通过SHA1算法生成签名。生成签名的步骤可以参考企业微信的文档。
步骤四:前端接入JSSDK
引入JSSDK:
<script src="https://res.wx.qq.com/open/js/jweixin-1.2.0.js"></script>
配置JSSDK:
wx.config({
beta: true,
debug: true, // 开启调试模式,上线时记得关闭
appId: '企业ID', // 必填,企业微信的corpID
timestamp: 时间戳, // 必填,生成签名的时间戳
nonceStr: '随机字符串', // 必填,生成签名的随机串
signature: '签名', // 必填,签名,见附录1
jsApiList: ['checkJsApi', 'getCurExternalContact'] // 必填,需要使用的JS接口列表
});
wx.ready(function(){
// wx.checkJsApi可以用来检查当前用户的版本是否支持相应接口
wx.checkJsApi({
jsApiList: ['getCurExternalContact'],
success: function(res) {
console.log(res);
}
});
});
实现好友添加功能: 可以使用
getCurExternalContact
接口来获取当前对话的外部联系人,并进行好友添加操作。
注意事项
- 调试模式:在开发阶段可以开启
debug: true
来查看配置错误和接口调用状态。 - 网络安全:确保在使用JSSDK时,网页是通过HTTPS协议访问的。
- 接口权限:确保企业微信应用有权限调用外部联系人相关接口。
通过以上步骤,你可以将H5应用成功接入企业微信JSSDK并实现好友添加功能,具体的接口细节和权限控制可以参考企业微信开发者文档保证功能实现的可靠性和安全性。