API 总览
本页为文档中心中的接口接入部分,按业务场景组织:
- 用户端 API:账号、用户资料、动态相关能力。
- 管理端 API:后台账号与用户导入能力。
接口域与调用身份
- 文档中的“用户端/管理端”表示能力分组,不等同于调用方身份强约束。
- 是否可调用,最终以接口自身鉴权规则为准(是否需要 token、需要什么 token、是否有权限校验)。
- 实际集成中,管理后台或服务端也可能调用“用户端 API”(例如账号、资料、动态能力),这是允许的。
- 对外联调时,建议按“接口能力 + 鉴权要求”理解,不按“页面归属”限制调用方。
通用请求约定
- 方法:当前接口以
POST为主,少量接口使用GET(如模板下载)。 - operationID:所有
POST请求统一要求在 Header 传入operationID。 - 请求体:业务接口默认使用 JSON body,推荐
Content-Type: application/json(当前未对该请求头做强校验)。 - 鉴权头:
token是否必需以具体接口为准(例如登录、发验证码等接口无需 token)。
请求格式例外
POST /user/import/xlsx:上传文件,使用multipart/form-data,文件字段名为data。GET /user/import/xlsx:下载模板,为文件下载接口(非 JSON 响应)。
返回结构(统一包裹)
除文件下载类接口外,API 统一使用同一响应包裹结构:
| 字段 | 类型 | 说明 |
|---|---|---|
| errCode | int | 错误码,0 表示成功 |
| errMsg | string | 错误简述 |
| errDlt | string | 错误详情,便于排查 |
| data | any | 业务数据(成功时返回) |
错误码体系(分层)
- 基础错误码:来自公共错误定义(如参数错误、权限错误、记录不存在、Token 相关错误)。
- 业务错误码:来自应用业务错误定义(主要在
20001+区间,如验证码频控、邀请码、账号状态等)。 - 兜底行为:未包装为业务错误的异常,会被统一映射为内部错误码(
500)。 - 完整明细:见 错误码明细。
联调处理建议
- 统一判定:
errCode = 0读取data,errCode != 0按失败分支处理。 - 失败分支建议优先展示
errMsg,并记录errDlt用于排障。