功能介绍
为了让飞书低代码平台更好的与外部系统进行交互，更加方便企业内灵活的连接各个业务系统，飞书低代码平台提供自动生成 Open API 的能力，让开发者经过简单配置即可生成供外部系统调用的 Open API 文档。
通过下面的步骤你可以新建 Open API，可以根据自己的需求设置该 Open API 可访问的方法，如：
- 了解对象元数据信息（对象字段配置、字段详情）
- 增删改查（CURD）应用内的记录
- 执行应用的流程、云函数
- 获取全局选项、全局参数
- 获取应用的页面链接、页面配置
- 上传、下载附件
- 获取应用 tenantAccessToken
- ……
基本信息
（一）请求参数说明
250px|700px|reset
（二）响应
调用 Open API 后的响应，将包含以下参数：
响应码 调用该 API 返回的结果，包含在 code 中。0 为成功，其余为失败响应描述 调用 API 的响应描述，包含在 msg 中返回数据 调用 API 后返回的具体内容，包含在 data 中记录总数 当通过记录列表类型的接口获取数据时会额外返回记录的总数，以便查询完整列表表
创建 OpenAPI
API 文档区分线上环境（生产环境）和 开发环境，线上环境的文档只能读写线上环境的数据，开发环境的文档只能读写开发环境的数据。
（一）创建 API 凭证
开发环境：进入「集成 -> API 凭证管理 -> 新建凭证」
250px|700px|reset
线上环境：进入「应用管理页 -> Open API -> 新建凭证」
250px|700px|reset
（二）配置 API 凭证可调用内容
进入 API 凭证后，你可以配置外部系统通过该凭证可操作的资源，如：
- 获取指定对象的元数据信息（基本配置、字段详情）
- 对指定对象的记录进行增删改查（CURD）
- 获取指定的全局选项、全局参数
- 执行指定的流程、云函数
- 获取应用的页面链接、页面配置
- 上传、下载附件
- 获取应用在飞书开放平台的 tenantAccessToken
250px|700px|reset
（三）自动生成 Open API 文档
开发环境：点击凭证中的「···」，获取到文档链接，即可访问到自动生成的 Open API 文档。
250px|700px|reset
线上环境：点击凭证中的「···」，获取到文档链接，即可访问到自动生成的 Open API 文档。
250px|700px|reset
使用 OpenAPI
（一）调用流程概览
250px|700px|reset
（二）获取 Client ID 和 Client Secret
线上环境和开发环境的凭证不互通，需要在各自环境的应用管理中新建。
开发环境：进入「集成 -> API 凭证管理」，查看 Client ID 和 Client Secret
250px|700px|reset
线上环境：进入「应用管理 -> Open API」，查看 Client ID 和 Client Secret
250px|700px|reset
（三）获取应用 Token
进入生成的 Open API 文档，在「获取应用 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
Open API 文档示例
其他
（一）调用频率限制
一个应用可以创建多个 API 凭证，应用内的所有 API 凭证共享下方列出的调用频率限制。超过限制时，会返回 code 为 k_op_ec_20003 的错误。
（二）错误码
250px|700px|reset
飞书低代码平台 Open API 错误码示例，请以实际生成的文档为准
（三）演示视频
- 创建 API 凭证
loading...
- 调用 OpenAPI
00:00
/
00:00
Audio/video is not supported
Please TryRefresh
Play
Fullscreen
Click and hold to drag
