API 文档(概览)
版本:v1 | 基础地址:由对接后分配
1. 接入准备
企业对接后会获得 `Client ID` 与 `Client Secret`。调用 API 前需完成鉴权并在请求头中携带访问令牌。
2. 鉴权示例
POST /v1/auth/token
Content-Type: application/json
{
"client_id": "your_client_id",
"client_secret": "your_client_secret"
}
3. 请求约定
- 请求与响应统一使用 `application/json`。
- 时间字段采用 ISO 8601 格式(UTC+8 需显式说明)。
- 建议使用幂等键避免重复提交。
4. 错误码示例
| Code | 含义 | 处理建议 |
|---|---|---|
| 40001 | 参数校验失败 | 检查必填字段与格式 |
| 40101 | 鉴权失败 | 刷新令牌或检查密钥 |
| 42901 | 调用频率超限 | 退避重试并降低并发 |
| 50001 | 服务内部错误 | 记录 request_id 并联系支持 |
5. 限流与稳定性
默认按应用级别实施限流策略。生产环境建议使用重试、熔断、超时与监控告警机制,保障链路稳定。
说明:本页为 API 文档概览示意。正式接口清单、字段定义与 SLA 以双方对接文档和合同约定为准。