易企办开发者 / REST API
接口响应与错误
区分网络、HTTP 和业务层失败，从响应中定位认证、权限、请求参数或限流问题。
同时读取 HTTP 和业务状态
易企办 OpenAPI 常用响应包含 Status、Data 和 Message。Status 为 0 表示业务成功。不同接口返回的数据结构以对应接口的定义为准。
{
"Status": 0,
"Data": null,
"Message": ""
}在服务端读取 JSON 业务响应
以下函数用于返回 JSON 业务状态的接口。它分别识别 HTTP 失败、缺少状态的响应和业务失败。下载文件时，按该接口定义读取响应内容。
export async function readApiResponse(response: Response) {
if (!response.ok) {
throw new Error(`易企办请求失败（HTTP ${response.status}）`);
}
const result = await response.json().catch(() => null) as {
Status?: number;
Data?: unknown;
} | null;
if (typeof result?.Status !== "number") {
throw new Error("易企办响应缺少有效的业务状态");
}
if (result.Status !== 0) {
throw new Error(`易企办业务处理失败（状态 ${result.Status}）`);
}
return result.Data;
}按失败原因排查
- 认证失败时核对目标域名、请求头和密钥来源。
- 资源无法访问时核对应用、记录标识和访问权限。
- 请求参数被拒绝时核对字段名、类型、必填项和索引配置。
- 限流或临时服务异常时采用退避重试。重试写入前确认业务动作能安全重复。
保留足够的排查信息
记录调用时间、方法、资源范围和响应状态。对敏感字段脱敏，再向管理员或支持团队提交问题。