API 认证与密钥

获取并传递密钥

请由有权限的管理员在易企办的系统设置中打开集成选项，找到 API Key。将密钥放到服务端环境配置或密钥管理服务。

curl --fail-with-body "https://api.yeeoffice.cn/v1/lists/APP_ID/LIST_ID" \
  -H "apiKey: ${YEEOFFICE_API_KEY}" \
  -H "Accept: application/json"

选择合适的调用方式

• 服务端调用使用 apiKey 请求头。
• 在产品内的自定义代码中优先使用宿主提供的 SDK，该调用按当前用户上下文运行。
• 发现泄露风险时更新密钥，并核对相关调用方使用了新配置。

识别旧集成的 URL 参数

公开规范也记录了在查询字符串中传入 apiKey 的方式。维护旧集成时，可把认证改为使用 apiKey 请求头，减少密钥进入 URL 历史、日志和监控记录的机会。

产品内控件的用户上下文

易企办表单中的自定义代码可通过宿主 SDK 按当前用户权限访问数据。外部网页或集成服务应通过自己的服务端调用公开 API，由服务端管理密钥。

• 查看自定义代码的查询示例

检查授权是否有效

先用有权限的测试列表发起只读请求，核对应用与列表标识、目标域名和响应状态，再接入业务流程。