企业微信集成模式(独享版)
1. 简介
独享版的用户如果需要创建企业微信集成模式版的账号,需要先创建企业,然后进行企业微信绑定。
2. 创建企业
创建企业时,需要填写以下信息:
- 企业名称:后期可修改;
- 管理员用户名:创建后不可修改,管理员通过此用户名登录企业;
- 登录密码:不可更改,管理员通过此用户名登录企业,因此创建时,需要记住该密码;密码至少包含数字、大写字母、小写字母及特殊字符中的三种
- 成员分配数量:默认 10 人,可直接输入人数,后期可修改。(成员分配数量不可超过剩余可分配人数)
3. 集成步骤
这一步需要登录 企业微信管理后台,获取企业微信有关参数与简道云账号进行绑定。
3.1 获取企业ID
3.2 获取AgentId和Secret
然后在「应用管理 >> 应用 >> 自建」新建一个自建应用,这一步是为了获取后文需要配置的自建应用ID、自建应用 secret 等参数。如下图所示:
填写基础资料后点击「创建应用」,如下图所示:
创建应用后,将应用中的 AgentId 和 Secret 分别复制下来进行备份:
3.3 进行域名校验
备份后继续滑动页面至底部,在「开发者接口 >> 网页授权及JS-SDK >> 设置可信域名」处「申请校验域名」,如下图所示:
在校验弹窗中,获取域名验证文件内容进行备份,如下图所示:
将下载好的文件上传至独享版控制台处:
先确认验证文件在指定域名下可以访问,校验地址:
https://private.yourdomain.com/WW_verify_xxxxxxxx.txt
地址中的部分参数需要替换成您自己的参数:
- https://private.yourdomain.com/:替换成您绑定在独享版账号上的域名;
- WW_verify_xxxxxxxx.txt:替换成刚刚企业微信中下载的域名校验文件的文件名称
当访问后显示的文件名与校验地址的文件名一致时,即表示可访问,效果如下:
3.4 配置企业可信 IP
自建应用需要设置企业可信 IP,企业可信 IP 为本企业服务器的 IP 地址,仅所配 IP 可通过接口获取企业数据。
注:这里的企业可信 IP 地址需要将本企业的服务器出网 IP 全都配上。
3.5 获取Token和EncodingAESKey
上滑页面,在「功能>>接收消息>>设置API接收」处点击随机获取按钮,分别获取 Token 和 EncodingAESKey 数据,如下图所示:
注:获取后请勿关闭此页面,后续还需返回此页面操作。
3.6 参数回填至独享版后台
登录独享版控制台,在企业管理处找到本文【2.节】创建的企业,点击企业详情,切换集成模式至「企业微信集成」。然后将上述步骤获取的所有参数分别配置到对应的位置,如下图所示:
参数对应关系如下:
企业微信相关参数 | 对应独享版企业填写内容 |
企业 ID | 本文【3.1节】获取的企业 ID |
AgentId | 自建应用 ID |
Secret | 自建应用 secret |
Token | 消息编码 token |
EncodingAESKey | 消息编码 aes_key |
全部填写好以后点击提交。
3.7 设置回调地址
回到【3.5节】的页面继续设置回调地址,回调地址的组成如下:
https://private.yourdomain.com/wxwork/corp/{corpid}/service
地址中的部分参数需要替换成您自己的参数:
- https://private.yourdomain.com/:替换成您绑定在独享版账号上的域名;
- {corpid}:替换成【3.1节】中获取的「企业ID」
将替换好的地址填入下图所示的位置:
设置好以后,点击「保存」。
3.8 设置主页地址
在企业自建应用中设置主页地址,主页地址的组成如下:
https://private.yourdomain.com/wxwork/{corpid}/dashboard
地址中的部分参数需要替换成您自己的参数:
- https://private.yourdomain.com/:替换成您绑定在独享版账号上的域名;
- {corpid}:替换成【3.1节】中获取的「企业ID」
设置主页网页地址,并勾选在「微信插件中始终进入主页」,如下图所示:
3.9 设置可信域名
在「开发者接口 >> 网页授权及JS-SDK」设置可信域名,域名地址为您绑定的独享版账号的域名,无需设置“https//:”等协议头,正确示例如下:
private.yourdomain.com
配置域名后点击「申请校验」,如下图所示:
然后勾选「用于OAuth2.0回调的可信域名是否校验」后点击确定,如下图所示:
校验成功后,会提示「修改成功」,如下图所示:
检验不通过则无法保存回调地址的设置,可以检查域名及之前的各项配置是否正确。
3.10 设置免登回调域
在自建应用中的「开发者接口 >> 企业微信授权登录」设置免登回调域:
域名地址为您绑定的独享版账号的域名,无需设置“https//:”等协议头,正确示例如下:
private.yourdomain.com
设置后点击「保存」,如下图所示:
4. 登录账号
4.1 创建者身份登录
至此,账号集成相关配置已全部完成。
登录独享版控制台,点击基础信息中的访问地址,通过企业管理员用户名和密码可登录企业中:
登录后可以看到,企业已由「内置模式」更换为「企业微信集成模式」,如下图所示:
登录 通讯录,可以看到已经同步过来的企业微信成员,如下图所示:
4.2 成员(管理员)身份登录
除创建者身份以外的其他成员(包括管理员)登录简道云时,可以通过企业账号 URL 扫码进行登录。如下图所示:
也可以直接在「企业微信工作台 >> 绑定的简道云应用」中直接登录。如下图所示:
5. 注意事项
1)管理中心填写 corpId 和 secret 错误:可能是真的填错了,也可能是企业微信自建应用的可信 IP 配置错误。
2)企业微信后台回调验证 openapi 失败:可以根据页面引导进行处理,如果还有问题可以找联系简道云技术支持让研发进行介入。