1. 简介
本文档为 Dora 平台对接企业微信机器人的前置操作流程,请按顺序完成,否则系统无法对接企业微信用户名/ID。
2. 前提条件
1)必须拥有企业微信管理后台权限;
2)已为 Dora 服务配置域名;
3)已获取 FineAI 组件所在服务器的 IP地址(用于企微可信 IP 配置)。
3. 操作步骤
3.1 创建企业微信自建应用
3.1.1 创建应用
企业微信管理员登录 企业微信管理后台,进入「应用管理>应用>自建」,创建应用。
注:请为 Dora 平台单独创建专属应用,已绑定 FineBI 等其他平台的应用不可重复使用。

3.1.2 设置应用信息与可见范围
设置应用 logo,应用名称与可见范围,其中可见范围需包括企业中所有会使用机器人的用户/部门,建议选择全员。
注:未被纳入应用可见范围的企业微信用户,将无法通过用户映射匹配到对应的 Dora 用户,也无法正常使用机器人。

3.2 配置「API接收」信息
3.2.1 进入API接收配置页
完成自建应用创建后,自动跳转至应用配置详情页,在「功能>接收消息」中点击「设置API接收」,进入接收消息服务器配置页。

3.2.2 接收消息服务器配置
1)参考以下规则,获取URL
https://{dora服务域名}/{BI服务后缀}/external/api/im/config/wecom/callback
示例:https://www.example.com/decision/external/api/im/config/wecom/callback
2)点击随机获取,系统自动生成 Token 与 EncodingAESKey
注:生成 Token 和 EncodingAESKey 后,先不要点保存!必须先去 Dora 管理后台填写这两项。

3.3 Dora后台配置应用对接
以超级管理员身份进入「Dora 管理后台>用户管理>IM用户映射」,点击应用对接的配置按钮,将上一步获取到的 Token 与 EncodingAESKey 填入弹窗中,并点击下一步,完成对接操作。

3.4 保存API接收
回到企业微信后台,保存【3.2】中的API接收配置。

3.5 配置网页授权及JS-SDK
1)在「开发者接口>网页授权及JS-JDK」卡片中,点击「设置可信域名」,将企业配置好的 Dora 访问域名添加至「可调用JS-JDK、跳转小程序的可信域名」中。
2)点击「申请校验域名」下载校验文件,校验文件的名称通常为:WW_verify_xxx.txt。
3)将校验文件添加至企业该 Dora 域名根目录下,确保 https://<域名>/WW_verify_xxx.txt 能直接访问,其中域名存放路径可参考下表:
| 工程访问方式 | 校验文件放置位置 |
|---|---|
非短域名 (访问地址含 webroot,如 http://域名/webroot/decision) | 宿主机挂载目录: /挂载目录/fanruanxxx/bi7-web/ROOT |
| 短域名或访问路径为空 (访问地址省略 webroot) | 需手动拷贝到 bi-web 容器内 webroot 根目录 操作示例: docker cp WW_verify_xxx.txt <bi-web 容器名>:/usr/local/tomcat/webapps/webroot/ |

3.6 配置企业可信IP
在「开发者接口>企业可信 IP」卡片中,点击配置按钮,在弹窗中添加 Dora 服务的出口 IP 地址,点击确认,完成白名单配置。
企业可信 IP 需遵循以下限制:
域名必须已 ICP 备案,且备案主体与企业微信企业主体一致或有关联。
新建的应用不支持 IP、带端口的地址或内网域名。
填写的必须是用户在移动端实际打开 Dora 时地址栏里的域名;若经过网关或反向代理访问,则填写网关对外的域名。

3.7 配置CorpSecret与CorpId
3.7.1 获取企业微信CorpSecret与CorpId
1)前往「自建应用>配置详情页>Secret」,点击查看,可获取 CorpSecret

2)前往「我的企业>企业信息」中,下拉页面,获取企业ID

3.7.2 Dora后台添加CorpSecret与CorpId
以超级管理员身份进入「Dora 管理后台>用户管理>IM用户映射」,继续【3.3】步骤的下一步,在弹窗中填入刚刚获取到的 CorpSecret 与 CorpId,点击「测试连接并保存」,页面提示「已配置」,即为配置成功。

3.8 确认网络连通
以上步骤全部完成后,建议测试并确认 Dora 服务器可以正常访问 qyapi.weixin.qq.com。
若后台配置了代理或私有化地址,则需要能访问对应的代理或私有化地址。
