mobile / AppConfigDocument · Commits

Go to a project

Authored by cl
Committed by Niall
Commit 0407fb320c2398484dcb04c86a750d2e748348e0 1 parent 709c50a2

调整接口 

Signed-off-by: Niall <niall.cao@gmail.com>
Inline Side-by-side
Showing 3 changed files with 80 additions and 78 deletions
1 # Yoho API 1 # Yoho API
2 2
3 -## 接口名称  
4 -软件初始化配置接口  
5 -  
6 -## URL  
7 -**[http://xxxx/config/user_config](https://xxxx/config/user_config)**  
8 -  
9 -## 支持格式  
10 -JSON  
11 -  
12 -## HTTP请求方式  
13 -POST  
14 -  
15 -## 请求参数  
16 -**参数列表：**  
17 -  
18 -| 字段 | 描述 | 类型 | 示例 |  
19 -|------------|--------|--------|----------------------|  
20 -| app_version| 当前版本号 | string | 3.8.0 |  
21 -| uid | 用户ID | string | 13423331 |  
22 -| client_type | 用户手机系统:Android,IOS | string | Android |  
23 -| screen_size | 屏幕尺寸 | string | 1080x1920 |  
24 -| udid | 设备唯一码 | string | 1d123sadao3 |  
25 -  
26 -**JSON格式：**  
27 -```  
28 -{  
29 - "app_version": "3.8.0",  
30 - "uid":"123123123",  
31 - "client_type":"Android",  
32 - "screen_size":"1080x1920"  
33 -}  
34 -```  
35 -  
36 -## 返回字段说明  
37 -**返回列表：**  
38 -  
39 -| 字段 | 描述 | 类型 | 示例 |  
40 -|------------|--------|--------|----------------------|  
41 -| code| 返回的code， 200， 304等，具体的服务器定义 | int | |  
42 -| message | 信息 | string | |  
43 -| md5 | 当前请求的唯一码 | string | |  
44 -| data | 配置参数数据，参考data,config列表 | object | |  
45 -  
46 -**config列表：**  
47 -  
48 -| 字段 | 描述 | 类型 | 示例 |  
49 -|------------|--------|--------|----------------------|  
50 -| format| "webp", "jpeg", 客户端需要显示的类型 | string | |  
51 -| clearcache | 里面有image(清空图片), data(清空数据缓存), init(初始化), code(本次清除的唯一码) | object | 1：清除 0 ：不清除 |  
52 -| https | 开启或者关闭https，默认关闭| string | 1：开启 0 ：关闭 |  
53 -| performance | 开启或者关闭性能上报开启 |string | 1：开启查 0：关闭 |  
54 -| iq | 图片分别在4G/WIFI,3G,2G的quality，默认85,50,30 |string | 85,50,30 |  
55 -| pv | 支付成功后是否需要向服务器发起订单状态查询请求，默认开启 |string | 1：开启 0：关闭 |  
56 -| pc | 特殊功能的校验密码32位md5小写 |string | 409bbd0d0f516a326f2080c26a10d530 |  
57 -**JSON格式：**  
58 -```  
59 -{  
60 -"code":200,  
61 -"message":"Config Success",  
62 -"md5":"1231231231231",  
63 -"data":{  
64 - "config":{  
65 - "format":"webp",  
66 - "https":"0",  
67 - "pv":"1",  
68 - "pc":"409bbd0d0f516a326f2080c26a10d530",  
69 - "performance":"1",  
70 - "iq":"85,50,30",  
71 - "clearcache":{  
72 - "image":1,  
73 - "data":1,  
74 - "init":1,  
75 - "code":159872617889  
76 - }  
77 - }  
78 - }  
79 -}  
80 -```  
  1 +# Yoho API
  2 +
  3 +## 接口名称
  4 +软件初始化配置接口
  5 +
  6 +## URL
  7 +**[http://xxxx/config/user_config](https://xxxx/config/user_config)**
  8 +
  9 +## 支持格式
  10 +JSON
  11 +
  12 +## HTTP请求方式
  13 +POST
  14 +
  15 +## 请求参数
  16 +**参数列表：**
  17 +
  18 +| 字段 | 描述 | 类型 | 示例 |
  19 +|------------|--------|--------|----------------------|
  20 +| app_version| 当前版本号 | string | 3.8.0 |
  21 +| uid | 用户ID | string | 13423331 |
  22 +| client_type | 用户手机系统:Android,IOS | string | Android |
  23 +| screen_size | 屏幕尺寸 | string | 1080x1920 |
  24 +| udid | 设备唯一码 | string | 1d123sadao3 |
  25 +
  26 +**JSON格式：**
  27 +```
  28 +{
  29 + "app_version": "3.8.0",
  30 + "uid":"123123123",
  31 + "client_type":"Android",
  32 + "screen_size":"1080x1920"
  33 +}
  34 +```
  35 +
  36 +## 返回字段说明
  37 +**返回列表：**
  38 +
  39 +| 字段 | 描述 | 类型 | 示例 |
  40 +|------------|--------|--------|----------------------|
  41 +| code| 返回的code， 200， 304等，具体的服务器定义 | int | |
  42 +| message | 信息 | string | |
  43 +| md5 | 当前请求的唯一码 | string | |
  44 +| data | 配置参数数据，参考data,config列表 | object | |
  45 +
  46 +**config列表：**
  47 +
  48 +| 字段 | 描述 | 类型 | 示例 |
  49 +|------------|--------|--------|----------------------|
  50 +| format| "webp", "jpeg", 客户端需要显示的类型 | string | |
  51 +| clearcache | 里面有image(清空图片), data(清空数据缓存), init(初始化), code(本次清除的唯一码) | object | 1：清除 0 ：不清除 |
  52 +| https | 开启或者关闭https，默认关闭| string | 1：开启 0 ：关闭 |
  53 +| performance | 开启或者关闭性能上报开启 |string | 1：开启查 0：关闭 |
  54 +| iq | 图片分别在4G/WIFI,3G,2G的quality，默认85,50,30 |string | 85,50,30 |
  55 +| pv | 支付成功后是否需要向服务器发起订单状态查询请求，默认开启 |string | 1：开启 0：关闭 |
  56 +| pc | 特殊功能的校验密码32位md5小写 |string | 409bbd0d0f516a326f2080c26a10d530 |
  57 +**JSON格式：**
  58 +```
  59 +{
  60 +"code":200,
  61 +"message":"Config Success",
  62 +"md5":"1231231231231",
  63 +"data":{
  64 + "config":{
  65 + "format":"webp",
  66 + "https":"0",
  67 + "pv":"1",
  68 + "pc":"409bbd0d0f516a326f2080c26a10d530",
  69 + "performance":"1",
  70 + "iq":"85,50,30",
  71 + "clearcache":{
  72 + "image":1,
  73 + "data":1,
  74 + "init":1,
  75 + "code":159872617889
  76 + }
  77 + }
  78 + }
  79 +}
  80 +```