GAS 云存档接口
基本信息
接口描述： 提供应用云存档管理功能，包括存档的读取、保存/覆盖、删除的操作。
接口地址： https://api.chinadlrs.com/developer/archive.php
请求方式： POST
响应格式： JSON
需要开放授权登录
此接口功能基于开放授权登录，所有操作都需要先获取有效的 access_token
具体的获取流程请参考《GAS 开放授权登录接口说明文档》
公共参数
查询参数 (Query Parameters)
| 参数名 | 类型 | 必填 | 描述 | 默认值 |
|---|---|---|---|---|
| type | number | 是 | 操作类型（1-3） | 无 |
| lang | string | 否 | 响应语言（zh/en） | zh |
查询参数
查询参数通过在接口地址后直接拼接的方式传递，地址和参数之间用 ? 分隔，多个参数之间用 & 连接。
例如操作类型为1、响应语言为英文的接口地址为：
https://api.chinadlrs.com/developer/archive.php?type=1&lang=en
请求头 (Headers)
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 必须设置为 application/json |
操作类型说明
1. 获取存档 (type=1)
功能描述： 读取指定用户的云存档数据。
请求体 (Body)
| 参数名 | 类型 | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| appid | int | 是 | 应用唯一标识符 | 1 |
| string | 是 | 用户邮箱 | "user@example.com" | |
| access_token | string | 是 | 加密后的访问令牌 | "p20T7UE/65lwBon6aSNYV7WPzbAvCvdObnK1y+pSH10=" |
数据加密
access_token 参数是经过加密的字符串，用于验证应用权限和保护数据安全
具体的加密算法请参考《数据加密说明文档》
请求示例
{
"appid": 1,
"email": "user@example.com",
"access_token": "p20T7UE/65lwBon6aSNYV7WPzbAvCvdObnK1y+pSH10="
}
响应参数
| 参数名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code | number | 状态码 | 200 |
| data | object | 响应数据对象 | |
| data.content | string | 加密后的存档内容 | "U2FsdGVkX1+vupppZksvRf5pq5g5XjFRIipRkwB0K1Y=" |
| data.app_version | string | 存档对应的应用版本 | "1.0.0" |
| data.update_time | string | 存档更新时间 | "2023-10-01 12:00:00" |
| msg | string | 响应消息 | "读取存档成功" |
2. 保存存档 (type=2)
功能描述： 创建或覆盖用户的云存档数据。
请求体 (Body)
| 参数名 | 类型 | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| appid | int | 是 | 应用唯一标识符 | 1 |
| string | 是 | 用户邮箱 | "user@example.com" | |
| access_token | string | 是 | 加密后的访问令牌 | "p20T7UE/65lwBon6aSNYV7WPzbAvCvdObnK1y+pSH10=" |
| content | string | 是 | 加密后的存档内容 | "T4AfaOJ9bdd0WZLc6CTIGY5p9V+Hs1HE7AOzfmdOAHNaRT3VQ..." |
| app_version | string | 是 | 加密后的应用版本号 | "1.0.0" |
数据加密
access_token, content, app_version 参数是经过加密的字符串，用于验证应用权限和保护数据安全
具体的加密算法请参考《数据加密说明文档》
请求示例
{
"appid": 1,
"email": "user@example.com",
"access_token": "p20T7UE/65lwBon6aSNYV7WPzbAvCvdObnK1y+pSH10=",
"content": "T4AfaOJ9bdd0WZLc6CTIGY5p9V+Hs1HE7AOzfmdOAHNaRT3VQ...",
"app_version": "1.0.0"
}
响应参数
| 参数名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code | number | 状态码 | 200 |
| data | object | 响应数据对象 | |
| data.content | string | 加密后的存档内容 | "U2FsdGVkX1+vupppZksvRf5pq5g5XjFRIipRkwB0K1Y=" |
| data.app_version | string | 存档对应的应用版本 | "1.0.0" |
| data.update_time | string | 存档更新时间 | "2023-10-01 12:00:00" |
| msg | string | 响应消息 | "存档成功" |
3. 删除存档 (type=3)
功能描述： 删除指定用户的云存档数据。
请求体 (Body)
| 参数名 | 类型 | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| appid | int | 是 | 应用唯一标识符 | 1 |
| string | 是 | 用户邮箱 | "user@example.com" | |
| access_token | string | 是 | 加密后的访问令牌 | "p20T7UE/65lwBon6aSNYV7WPzbAvCvdObnK1y+pSH10=" |
数据加密
access_token 参数是经过加密的字符串，用于验证应用权限和保护数据安全
具体的加密算法请参考《数据加密说明文档》
请求示例
{
"appid": 1,
"email": "user@example.com",
"access_token": "p20T7UE/65lwBon6aSNYV7WPzbAvCvdObnK1y+pSH10="
}
响应参数
| 参数名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code | number | 状态码 | 200 |
| data | null | 无数据 | |
| msg | string | 响应消息 | "删除存档成功" |
成功响应示例
{
"code": 200,
"data": {
"content": "U2FsdGVkX1+vupppZksvRf5pq5g5XjFRIipRkwB0K1Y=",
"app_version": "1.0.0",
"update_time": "2023-10-01 12:00:00"
},
"msg": "读取存档成功"
}
错误响应示例
{
"code": 400,
"data": null,
"msg": "参数缺失或无效"
}
状态码说明
| 状态码 | 描述 | 解决方案 |
|---|---|---|
| 200 | 操作成功 | |
| 400 | 请求参数缺失或无效 | 检查必填参数是否提供且格式正确 |
| 400 | 存档内容和应用版本不能为空 | 检查content和app_version参数是否提供 |
| 400 | 存档内容必须是有效的JSON对象或数组 | 验证content参数是否为有效JSON格式 |
| 400 | 存档内容大小超过限制（最大1MB） | 减少存档数据量 |
| 401 | 访问令牌验证失败 | 检查access_token是否正确有效 |
| 404 | 未找到存档记录 | 确认该用户是否存在存档数据 |
| 404 | 存档不存在，删除失败 | 确认要删除的存档是否存在 |
| 500 | 数据库操作失败 | 联系系统管理员 |