应用配置获取接口
基本信息
接口描述: 用于获取应用的配置信息,返回加密后的配置内容。
接口地址: https://api.chinadlrs.com/developer/config.php
请求方式: POST
响应格式: JSON
请求参数
请求头 (Headers)
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 必须设置为 application/json |
查询参数 (Query Parameters)
| 参数名 | 类型 | 必填 | 描述 | 默认值 |
|---|---|---|---|---|
| lang | string | 否 | 响应语言(zh/en) | zh |
查询参数
查询参数通过在接口地址后直接拼接的方式传递,地址和参数之间用 ? 分隔,多个参数之间用 & 连接。
例如响应语言为英文的接口地址为:
https://api.chinadlrs.com/developer/config.php?lang=en
请求体 (Body)
| 参数名 | 类型 | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| appid | int | 是 | 应用唯一标识符 | 1 |
请求示例
{
"appid": 1
}
响应参数
响应参数表
| 参数名 | 类型 | 描述 | 示例 |
|---|---|---|---|
| code | number | 状态码 | 200 |
| data | object | 配置信息对象 | |
| data.config | string | 加密后的配置内容 | "U2FsdGVkX1+...加密后的配置内容" |
| msg | string | 响应消息 | "操作成功" |
数据加密
为了防止配置内容被恶意篡改,data.config 响应参数做了加密处理,客户端需使用 AppToken 解密后再解析配置内容
成功响应示例
{
"code": 200,
"data": {
"config": "U2FsdGVkX1+...加密后的配置内容"
},
"msg": "操作成功"
}
错误响应示例
{
"code": 404,
"data": null,
"msg": "应用不存在"
}
状态码说明
| 状态码 | 描述 | 解决方案 |
|---|---|---|
| 200 | 配置获取成功 | |
| 400 | 参数缺失或无效 | 检查 appid 参数是否提供且格式正确 |
| 404 | 应用不存在或配置不存在 | 验证 appid 是否正确,或确认该应用是否已配置 |