1. 概述

本产品提供了微信小程序集成企业微信的能力,目前仅私有部署版本支持微信小程序集成功能。通过企业微信后台的配置可以实现本产品与企业微信用户的打通,实现免密登录,登录后可在企业微信上轻松查看报告,且能收到度量预警的消息通知。

通过在微信开发者后台和产品后台的配置,即可实现企业微信集成功能,具体操作步骤如下:

2. 准备外网可访问的https域名

在配置服务器域名时,由于微信仅支持https域名且必须外网可访问,所以接入前必备的条件为:

  • 域名为https安全域名,需要证书
  • https域名可以在外网访问,端口可开443端口或80端口
  • 域名指向BI服务器,使用该域名可直接访问本产品

鉴于私有化部署BI工具的数据安全性,对于外网访问有数在此基础上提供额外的安全策略:

  • 最小可用原则,仅开放443端口
  • 进微信小程序服务器可访问该域名,具体操作为nginx配置为仅限指定user_agent访问,小程序的user_agent为mini program
  • 关闭微信小程序搜索登入入口,无法通过搜索小程序登入BI

以上可实现该域名仅有企业微信这一个入口可以访问,风险最小化。

3. 注册微信公众平台小程序

您需要在微信公众平台注册账号,按照微信官方的[小程序接入流程]进行小程序的上架:

注册链接:https://mp.weixin.qq.com/wxopen/waregister?action=step1

  • 填写账号信息

  • 邮箱激活

  • 信息登记 选择企业为主体类型(个人认证无法配置业务域名这里必须选择企业)

登记主体信息,需要营业执照注册号及注册认证,认证方式有两种:

①对公账号向腾讯公司小额打款验证(推荐)

  • 小额打款金额一般为0.1元-1元不等
  • 款项会在认证结束后退回

②微信认证(需300元额外费用)

4. 配置小程序信息

内容包括小程序名称,小程序简称,小程序头像,小程序介绍,及服务类目(服务类目选择工具-计算类)

小程序名称修改,仅能通过微信认证方式,需要300元费用,修改入口为 设置-基本设置;小程序简称、小程序头像、介绍和服务类目可以免费修改

5. 上传小程序代码

(1)下载并安装微信开发工具:https://developers.weixin.qq.com/miniprogram/dev/devtools/stable.html

(2)扫码登录,导入项目

(3)解压代码包,将代码包中的project.config.json文件中的APPID替换为当前小程序的APPID(代码包请联系王我方技术支持获取对应版本包)

(4)导入项目,目录设置为解压后的代码包文件夹,然后点击上传;

(5)填写版本号及项目备注;

(6)返回小程序页面,在管理-版本管理中设置该版本为体验版;

(7)生成体验版二维码备用

6. 配置域名

(1)服务器信息

开发-配置服务器信息中配置:

  • request域名:表示微信可接受的接口请求域名,需填写当前私有部署的https域名
  • socket合法域名:表示微信可接受的socket通讯域名,需填写和当前私有部署本产品域名相同的wss前缀域名
  • downloadFile合法域名:表示微信可接受的下载域名,一般不需要填写,如果在有数中有使用到自己的cdn,则需要填写改cdn域名。

(2)业务域名

填写当前域名,需下载校验文件,放到服务器 /youdata/custom/static目录下;

7. 提交审核和发布

(1)准备一个测试账号,需交由微信审核人员审核,该账号权限最小化(建议仅可查看一个测试报告),配置1个最简单的报告,一个表格或图表即可。

(2)手机扫码登入体验版,截图并录制视频,图片内容建议为(域名登入页,账号登入页,登入后界面,报告页),录制视频的内容为从填入域名开始到报告页结束。

(3)管理-版本管理-提交审核

(4)填写对应信息,选择加急审核,一般2小时内会有结果

8. 在企业微信后台关联小程序

小程序成功上架后,在企业微信后台关联已上架的小程序,路径:应用管理-小程序;点击【关联小程序】,由小程序后台的管理员扫码即可成功关联小程序:

9. 产品后台配置

(1)创建完成后,点击小程序,可以自行设置小程序的可见范围,这里需要特别注意一个参数:小程序的Secret,该参数后续将填写至产品后台;

(2)点击我的企业,可见“企业ID”参数,这也是后续需要填写到产品后台的参数;

(3)第三个参数,需要在小程序的管理后台获取,点击开发-开发设置,查看AppID(小程序ID);

(4)在产品管理后台的设置页面,可以对企业微信集成的开启进行控制,若要在企业微信中启用小程序,首先在[企业微信集成设置]下打开集成开关,其次填写上文所说的三个参数:企业微信后台提供的企业ID、Secret,以及小程序管理后台提供的AppID。

10. 用户与企业微信账号的匹配

用户在企业微信上首次登录小程序后,在企业域管理-人员信息页面的人员列表可以看到已匹配用户的基本信息,且该用户下次即可在企业微信免密登录小程序。

对于部分用户,管理员可手动[设置企业微信匹配],通过企业微信用户的手机号或者姓名与有数用户进行匹配,匹配完成后的用户可以直接在企业微信免密登录小程序。

注:匹配需要有数服务器获取企业微信的通讯录信息,该任务为每天凌晨两点的定时同步任务,所以一般做匹配建议放在配置完成后第二天