跳转至

平台对接

支持企业微信、钉钉、飞书接入,支持扫码登录、免密登录等。

对接企业微信

1 企业微信设置

1.1 配置平台对接信息

DataEase 对接企业微信,需要填写以下信息:

  • 企业 ID
  • 应用 ID
  • 应用密钥

对接信息的获取,需要以管理员权限登录企业微信后台,如下图所示。

对接企业微信

获取企业 ID,获取路径:企业微信后台->我的企业->企业信息,如下图所示。

对接企业微信

获取应用 ID 与应用密钥,获取路径:企业微信后台->应用管理;
首先需要创建一个对应的应用,在【应用管理】栏的【应用】中,滚动到页面最下方,点击【创建应用】。

对接企业微信

在弹出的【创建应用】对话框中输入应用的相关信息后确认即可,此处我们创建一个名叫“SQLBot 测试”的应用。

对接企业微信

创建完成后会自动跳转到新建应用的详情界面,按照如下图所示获取应用 ID 与应用密钥即可。

对接企业微信

1.2 应用权限设置

SQLBot 对接企业微信,让安装 SQLBot 的服务器可以访问企业微信的接口,需要设置企业可信域名。可信域名若使用非标准端口需要带上端口号,此处不可使用 IP 地址。
可参考可信域名验证配置操作步骤可参考。若校验不通过,可按照提示信息做相关操作即可。

对接企业微信

对接企业微信

企业可信 IP 为本企业服务器的 IP 地址,仅所配 IP 可通过接口获取企业数据;
进入应用,在最下方可以看到“企业可信 IP”,输入 SQLBot 服务器 IP 即可,回调域名 sqlbot.fit2cloud.com 的 IP 为212.1.121.111,则在配置中填写该 IP。

对接企业微信

对接企业微信

在 Web 网页里授权回调域,域名请根据实际情况进行修改。

对接企业微信

要支持扫码登录,需要进行企业微信授权登录的设置。

对接企业微信

根据以上信息完成下图界面的信息录入并校验、保存。

对接企业微信

1.3 企业微信免登设置

在应用的【应用主页】栏点击【配置】,将上一步获取到的应用主页地址填入电脑端网址即可。

对接企业微信

在企业微信工作台中找到 DataEase 应用,PC 端和移动端点击该应用即可免登访问 SQLBot。

对接企业微信

2 钉钉设置

2.1 配置平台对接信息

DataEase 对接钉钉,需要填写以下信息:

  • 应用 ID
  • 应用 Key
  • 应用密钥

获取应用 ID 和应用密钥,需要在钉钉工作台的【应用管理】中创建一个对应的应用,可以先登录工作台 https://oa.dingtalk.com/index.htm#/microApp/microAppList
创建应用,需要在【应用管理】中,滚动到页面最下方,点击【自建应用】。

对接钉钉平台

在弹出的【创建企业内部应用】对话框中输入应用的相关信息后确认即可。

对接钉钉平台

获取应用信息,在应用创建完成后,可以在刚才创建的“SQLBot 测试应用”中的【应用凭证】里找到所需的信息,其中:

  • AgentId - 应用 ID
  • AppKey - 应用 Key
  • AppSecret - 应用密钥

对接钉钉平台

2.2 应用权限设置

授权登录,要支持扫码登录,需要进行钉钉授权登录的设置,进入应用“SQLBot 测试应用”,在【分享设置】的【回调域名】里中添加授权回调域,注意域名需要与访问 SQLBot 平台的域名一致。

对接钉钉平台

同时在【安全设置】的【重定向 URL】里中添加授权回调域,注意域名一致。

对接钉钉平台

权限控制,进入到【权限管理】中,添加权限。

对接钉钉平台

所需权限如下图所示。

对接钉钉平台

按照以上信息完成下图所示的平台对接配置即可。

对接钉钉平台

2.3 钉钉免登设置

在钉钉开放平台的【应用能力】栏中,进入【网页应用】,设置【应用首页】和【PC端首页地址】。地址格式为:http(s)://xxx.xxx.xxx/?client=dingtalk&corpId=CORPID。注意 corpId=CORPID 需替换成真正的 CORPID。可实现 PC 端和移动端免密登陆。

对接钉钉平台

对接钉钉平台

3 飞书设置

3.1 配置平台对接信息

SQLBot 对接飞书,需要填写以下信息:

  • 应用 ID
  • 应用密钥

获取应用 ID 和应用密钥,需要以管理员权限登录飞书管理后台,在【工作台】的【应用管理】中创建一个对应的应用。

对接飞书平台

对接飞书平台

对接飞书平台

创建应用,在弹出的【创建应用】对话框中输入应用的相关信息后确认即可,此处创建一个名叫“SQLBot 测试”的应用。

对接飞书平台

点击【确定创建】按钮后,完成应用创建并进入应用。提醒进行配置和发布,再进行配置后,进行版本发布。

对接飞书平台

新建 App,添加网页应用,设置桌面端主页为 SQLBot 服务器地址。如果是 IP 地址,则填入 http(s)://域名/。

对接飞书平台

对接飞书平台

3.2 应用权限设置

在【安全设置】里添加重定向 URL,即 SQLBot 服务器地址。与网页应用设置的地址域名一致。

对接飞书平台

应用授权,在应用的【权限管理】里进行应用的相关授权,具体权限参考下图:

对接飞书平台

新建应用版本,在应用的【版本管理与发布】中创建应用版本,如下图所示。

对接飞书平台

对接飞书平台

申请线上发布并自动审核。

对接飞书平台

获取应用 ID 和应用密钥,完成下图所示的平台对接配置即可。

对接飞书平台

3.3 飞书免登设置

在飞书开放平台中,选择 DataEase 应用。在【应用功能】下的【网页】里,开启网页功能,并配置【桌面端主页】和【移动端主页】。地址格式:http(s)://xxx.xxx.xxx.xxx/?client=lark。可实现 PC 端和移动端免密登陆。

对接飞书平台

对接飞书平台

4 同步用户

4.1 组织用户同步

在 SQLBot 的系统管理的用户管理界面中,点击右上角的【同步用户】按钮,选择相应的同步用户界面。

同步用户

勾选所需同步的用户后,点击确认即可。

同步用户

同步用户