优化，添加115接口文档

2026-10-14 00:56:37 +08:00 · 2026-09-05 14:32:58 +08:00
parent d00b14df55
commit 0e9fb2c937
57 changed files with 5682 additions and 76 deletions
@@ -0,0 +1,101 @@
+## 获取云下载配额信息
+
+### 基本信息
+
+| 属性          | 内容                              |
+|:-------------|:----------------------------------|
+| 接口名称      | 获取云下载配额信息                  |
+| 接口版本      | v1.0                              |
+| 接口路径      | /get_quota_info                   |
+| 请求方法      | GET                               |
+| 接口状态      | 生产环境                           |
+
+### 接口说明
+
+获取当前授权用户各类云下载配额的使用情况和过期明细。
+
+### 接口地址
+
+```
+https://proapi.115.com/open/offline/get_quota_info
+```
+
+### 请求方式
+
+```
+GET
+```
+
+### 认证方式
+
+```
+Authorization: Bearer access_token
+```
+
+### 请求参数
+
+无。
+
+### 请求示例
+
+```shell
+curl 'https://proapi.115.com/open/offline/get_quota_info' \
+  -H 'Authorization: Bearer <access_token>'
+```
+
+### 响应字段说明
+
+| 字段                                        | 类型     | 描述                 |
+|:--------------------------------------------|:---------|:---------------------|
+| state                                       | boolean  | 状态，true表示成功     |
+| message                                     | string   | 返回信息              |
+| code                                        | int      | 错误码                |
+| data                                        | object   | 云下载配额数据         |
+| data.package                                | object[] | 配额类型列表           |
+| data.package[].surplus                      | int      | 该类型剩余配额         |
+| data.package[].used                         | int      | 该类型已用配额         |
+| data.package[].count                        | int      | 该类型总配额           |
+| data.package[].name                         | string   | 该类型配额名称         |
+| data.package[].expire_info                  | object[] | 该类型配额过期明细      |
+| data.package[].expire_info[].surplus        | int      | 明细项剩余配额         |
+| data.package[].expire_info[].expire_time    | int      | 明细项过期时间         |
+| data.count                                  | int      | 用户总配额数量         |
+| data.surplus                                | int      | 用户总剩余配额数量      |
+| data.used                                   | int      | 用户总已用配额数量      |
+
+#### 响应的 code 字段(错误码)说明
+
+| 错误码 | 说明     | 解决方案     |
+|:-------|:---------|:-------------|
+| 990002 | 参数错误 | 检查授权信息 |
+
+### 响应示例
+
+```json
+{
+  "state": true,
+  "message": "",
+  "code": 0,
+  "data": {
+    "package": [],
+    "count": 0,
+    "surplus": 0,
+    "used": 0
+  }
+}
+```
+
+### 性能与安全说明
+
+- 用户身份由 Bearer access_token 解析，请求参数不能指定115账号。
+- 接口按应用、用户和接口维度执行频率限制。
+
+### 注意事项
+
+- 云下载配额以响应中的 `data` 字段为准。
+
+### 修改历史
+
+| 修改时间                         | 修改说明 |
+|:-----------------------------|:-----|
+| 2025年04月01日(周二) 00:00:00 | 创建文档 |