飞书集成
Sugar BI 的私有部署版本可以借助企业自建应用实现飞书集成,通过配置可以将Sugar BI和飞书账号打通,实现用户免登陆访问Sugar BI,在飞书中方便快捷的浏览Sugar BI。
创建企业自建应用
企业管理员登录飞书开放平台,点击首页的创建应用
,进入开发者后台,点击创建企业自建应用
。
配置开发信息
创建成功后,点击我们刚刚创建的应用进入应用管理页面,选中应用功能-网页
菜单,打开启用网页
,在网页配置中填写您Sugar BI的首页地址。
如果您需要使用Sugar BI的定时推送和数据预警功能,还需要开启机器人能力
。
在安全设置
菜单中设置重定向 URL 为Sugar BI的域名和端口号+login/appOauthCallback
。
在权限管理
中开启以下权限:
- 获取用户 user ID
如果要使用机器人进行数据预警的话,还需要额外开启以下权限:
- 获取与发送单聊、群组消息
- 获取用户发给机器人的单聊消息
如果要使用机器人进行定时推送的话,除了上述权限外还要开启获取与上传图片或文件资源
。
完成了这些配置之后,点击应用发布-版本管理与发布
菜单,点击创建版本
,填写新的版本号、更新说明,然后保存。
创建完版本之后,再点击申请发布
。
发布之后,在手机上重启飞书应用,就可以在工作台中找到我们刚刚创建的应用。
在Sugar BI中配置相关参数
您的企业自建应用创建成功后,需要将App ID
和App Secret
信息填到env
文件中。App ID
和App Secret
可以在凭证和基础信息
中找到。
将企业 ID、secret、AgentId 信息填到env
文件中,sugar_lark_oauth_appid
对应App ID
、sugar_lark_oauth_secret
对应App Secret
sugar_lark_oauth_appid=
sugar_lark_oauth_secret=
如果您使用的是私有部署版的飞书,那么还需要额外配置两个环境变量。
# 使用私有部署的飞书
sugar_lark_use_private=true
# 您飞书私有部署的域名
sugar_lark_origin=https://open.wiki.cn
飞书内访问Sugar BI
在【飞书 APP】-【工作台】中找到您创建的应用,点击进入应用。第一次在飞书中打开Sugar BI时,会进入绑定邮箱页面,绑定您Sugar BI的账号。
绑定成功后,您之后都可以在飞书上实现免密登录Sugar BI。