飞书项目帮助中心Appearance
开发指南
域名设置
私有部署版本下，考虑API 域名不一，需要自行查询填写。如下图示获取平台域名。
本文档的说明中，路径中带有冒号 “:” 的部分为路径参数，如下方提示所示。
路径参数提示
https://{Base URL}/open_api/:project_key/business/all
|-- 路径参数 --|
示例：
https://{Base URL}/open_api/projectkeyisme/business/all
|-- 路径参数 --|
则以上参数 projectKey 的值为 projectkeykeyisme
请求体说明
本文档请求参数的字段中，除路径参数和 url 参数之外，其他字段均为请求体中的参数。请求体默认为 JSON 格式，存在请求体的接口需要在 Header 中加入 Content-Type:application/json。
| 字段 | 值 | 必须填写 |
|---|---|---|
| Content-Type | application/json | 必须 |
| X-PLUGIN-TOKEN | 用户在开放平台中获取的 Token，参考插件身份凭证章节。 | 必须 |
| X-USER-KEY | 当选择使用插件身份凭证的时候，需要额外必选指定接口调用的用户user_key，user_key可双击用户头像获取 | 可选 |
| X-IDEM-UUID | 写类型接口的幂等串，可以不设置，设置后会进行同一个X-PLUGIN-TOKEN下同一接口的幂等判断 | 可选 |
插件配置与安装
- 网站左下角点击开发者后台；
- 点击创建插件，创建一个属于你的插件；
- 权限管理中选择你所需的 Open API 权限；
- 版本管理中创建插件版本，每次更新权限都需要重新发布一个新的插件版本；
- 发布版本，如提示插件图标、长描述暂未填写，请至[基本信息]页面检查必填项是否填写；
- 安装插件，如插件已经安装，但是发布了新的插件版本，需在插件管理界面更新；
名词解释
中文名词 | 英文名词 | 描述 |
空间域名 | simple_name |   |
字段ID | field_key |  |
频控
接口对每个 token 调用单个接口限制了 15 QPS 的访问限制，请合理设计调用逻辑。
错误码
错误码文档对非 500 类错误码给出了可能的错误原因和自行排查的建议，请优先自行排查。请使用 err_code 对应的错误码进行排查。
网关错误
当输入参数不符合要求，会触发网关错误，请自查请求参数格式，错误如下所示：
