OpenAPI|飞书低代码平台

OpenAPI|飞书低代码平台

飞书低代码平台手册精选NaN-NaN-NaN
产品功能
💡
本文档主要介绍线上环境 OpenAPI 的使用方式,若涉及开发环境可参考《Open API 使用指南
功能介绍
为了让飞书低代码平台更好的与外部系统进行交互,更加方便企业内灵活的连接各个业务系统,飞书低代码平台提供自动生成 Open API 的能力,让开发者经过简单配置即可生成供外部系统调用的 Open API 文档。
通过下面的步骤你可以新建 Open API,可以根据自己的需求设置该 Open API 可访问的方法,如:
  • 了解对象元数据信息(对象字段配置、字段详情)
  • 增删改查(CURD)应用内的记录
  • 执行应用的流程、云函数
  • 获取全局选项、全局参数
  • 获取应用的页面链接、页面配置
  • 上传、下载附件
  • 获取应用 tenantAccessToken
  • ……
基本信息
(一)请求参数说明
飞书低代码平台的 Open API 参数遵循 RESTFul 风格。其中,接口域名固定为:ae-openapi.feishu.cn,其他参数如下图所示,请注意各参数在请求中的位置:
注意:字节内网访问 OpenAPI 接口域名需更改为 oapi-kunlun.bytedance.net
250px|700px|reset
(二)响应
调用 Open API 后的响应,将包含以下参数:
  • 响应码 调用该 API 返回的结果,包含在 code 中。0 为成功,其余为失败
  • 响应描述 调用 API 的响应描述,包含在 msg 中
  • 返回数据 调用 API 后返回的具体内容,包含在 data 中
  • 记录总数 当通过记录列表类型的接口获取数据时会额外返回记录的总数,以便查询完整列表
创建 OpenAPI
(一)创建 API 凭证
进入「应用管理页」>>「OpenAPI」>> 「API 凭证」新建凭证
(二)配置 API 凭证可调用内容
进入 API 凭证后,你可以配置外部系统通过该凭证可操作的资源,如:
  • 获取指定对象的元数据信息(基本配置、字段详情)
  • 对指定对象的记录进行增删改查(CURD)
  • 获取指定的全局选项、全局参数
  • 执行指定的流程、云函数
  • 获取应用的页面链接、页面配置
  • 上传、下载附件
  • 获取应用在飞书开放平台的 tenantAccessToken
250px|700px|reset
(三)自动生成 Open API 文档
点击凭证中的「···」>>「分享 API 文档」,获取到文档链接,即可访问到自动生成的 Open API 文档。
250px|700px|reset
使用 OpenAPI
(一)调用流程概览
(二)获取 Client ID 和 Client Secret
进入「应用管理页」>>「OpenAPI」>> 「API 凭证」,查看 Client IDClient Secret
250px|700px|reset
(三)获取应用 Token
进入生成的 OpenAPI 文档,在「获取应用 Token」章节可以通过提供的接口路径(/auth/v1/appToken)、携带请求体(Client ID Client Secret)获得应用 Token。
说明:飞书低代码平台 Open API 返回 的 Token 直接使用即可,无需再拼接 Bearer 值。
250px|700px|reset
(四)携带应用 Token 调用 Open API
获取到应用 Token 后,即可调用 Open API。具体调用方法请参考生成的 Open API 文档。
250px|700px|reset
先进生产力和业务协同平台
联系我们立即试用

先进团队,先用飞书

欢迎联系我们,飞书效能顾问将为您提供全力支持
分享先进工作方式
输送行业最佳实践
全面协助组织提效
联系我们立即试用