易企办开发者 / REST API
易企办 REST API
了解外部系统怎样与易企办的业务数据、审批、人员、文件和 AI 智能体连接，从一次只读请求开始。
可以用接口处理什么
- 读取列表结构和业务记录，或从可信服务创建和更新记录。
- 按需要管理组织、用户、岗位和服务门户成员。
- 启动工作流、读取待办，或从受信任的服务处理任务。
- 查询智能体、处理文件，或配置业务事件回调。
准备资源和认证信息
- 确认要连接的应用、列表、审批表单或服务门户，并取得当前环境的资源标识。
- 由有权限的管理员在易企办系统设置的集成选项中获取 API Key，并保存到服务端的密钥管理配置。
- 在接入 ERP、CRM 或报表服务前，先用有权限的测试列表核对身份、字段和访问范围。
中国版 API 基地址
https://api.yeeoffice.cn/v1发起第一次只读请求
用当前环境的应用和列表标识替换示例，从可信服务或终端发送请求。请求头中的 apiKey 由服务端环境配置提供。
curl --fail-with-body "https://api.yeeoffice.cn/v1/lists/APP_ID/LIST_ID" \
-H "apiKey: ${YEEOFFICE_API_KEY}" \
-H "Accept: application/json"请求频率限制
中国版公开规范对每个商户账号标注的上限是每秒 10 个请求，适用于所有档位。多个集成同时运行时，请合并计算同一商户账号的请求量。
批处理可通过队列或定时任务控制速率。发生限流时逐步延长重试间隔，写入请求重试前核对已有结果。
读取接口响应
同时检查 HTTP 状态和业务响应中的 Status。Status 为 0 时读取 Data，失败时可参考 Message 排查。文件内容等接口的返回格式以对应定义为准。
{
"Status": 0,
"Data": null,
"Message": ""
}查询记录和接收回调
- 按字段选择、筛选、排序和分页读取列表记录。对筛选或排序字段先核对索引配置。
- 工作流任务事件通过 POST 送到集成服务，事件渠道和类型分别位于 Channel 和 Type 请求头。
按任务查找接口
从 AI 工具接入易企办
支持远程 MCP 和 OAuth 的 AI 工具可以连接易企办，并按登录账号的权限读取数据和使用工具。