e0123 开放接口文档
本文档面向已开通接口权限的合作方,覆盖 e0123 开放平台提供的全部接口,左侧导航按业务分类列出,持续更新中。
返回格式:application/json
字符编码:UTF-8
请求方式:GET / POST(除注明外)
鉴权说明
- 每次请求必须携带
companyId;若公司已启用 token 校验,还须携带token。 - 使用前请联系我方开通对应接口权限并获取
token。 - 返回顶层统一结构:
{ "returnCode": "SUCCESS"/"FAIL", "returnMsg": "...", ...业务字段 }。
通用错误码
| returnMsg | 原因 |
|---|---|
| 未开通接口权限无法查询! | 公司未开通接口 |
| 公司已经启用token,请先获取授权信息,然后携带token再来请求数据 | 公司启用了 token 校验但未传 token |
| 请先联系管理员赋予接口权限! | token 无效,或未授予该接口权限 |
| 只能从指定的ip请求接口! | 调用方 IP 不在接口权限配置的白名单内 |
关于 updateTimeStart / updateTimeEnd
多数列表接口支持这两个可选参数用于增量同步,格式
yyyy-MM-dd,按天闭区间过滤(>= start 且 <= end)。个别接口的过滤逻辑有特殊说明,见对应接口页的"补充说明"。