Appearance
概述
1.1 接口地址
| 环境 | 基础地址 |
|---|---|
| 开发环境 | http://dev-api.ailian.com |
| 测试环境 | http://test-api.ailian.com |
| 生产环境 | https://api.ailian.com |
所有开放接口路径前缀为 /api/open/v1/。
1.2 通信协议
- 协议:HTTP / HTTPS
- 方法:GET / POST / PUT
- 数据格式:JSON
- 字符编码:UTF-8
1.3 接入流程
1. 联系平台管理员,申请接入 → 获取 app_key + app_secret
2. 根据本文档完成签名逻辑开发
3. 在测试环境联调
4. 联调通过后,申请生产环境密钥1.4 接口版本策略
- URL 路径中的
/v1/已预留版本空间,后续不兼容变更时升版(如/v2/) - 新增字段不升版本,旧版本至少保留 6 个月过渡期
- 删除或变更已有字段时才升版本,并通过响应头
X-API-Deprecated: true+X-API-Sunset: <date>提前通知 - 建议调用方在解析响应时忽略未知字段,保持向前兼容
1.5 请求体大小限制
| 接口类型 | 请求体上限 |
|---|---|
| 普通接口 | 1 MB |
| 批量接口 | 5 MB |
超限返回 HTTP 413 {"code": 41301, "message": "请求体过大"}。