Yoho-Documents / API-Interfaces · Commits

Go to a project

Authored by henry
Commit 7d191ddb9732daeb2635c6955f82c76a65b5f1af 1 parent 2a621ff9

Update README.md

Inline Side-by-side
Showing 1 changed file with 147 additions and 146 deletions
1 -## 1、获取用户签到信息##  
2 -  
3 -获取用户签到信息（method=app.sign.userSignInfo）  
4 -#### 请求参数  
5 -| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |  
6 -|:-------| -----:|-----:|-----:|-----:|----:|  
7 -|uid|int|否|213|0|用户id|  
8 -  
9 -注意，通用的头部没有列出。  
10 -请求示例  
11 -http://192.168.102.217:8080/gateway/?method=app.sign.userSignInfo&uid=213&debug=XYZ  
12 -  
13 -### 响应(data里所有的字段返回都是string类型)  
14 -code为200即为成功，否则是失败。  
15 -响应JSON格式如下所示:  
16 -```json  
17 -{  
18 - "alg": "SALT_MD5",  
19 - "code": 200,  
20 - "data": {  
21 - "constantDay": "1",  
22 - "pushFlag": "1",  
23 - "signInfoList": [  
24 - {  
25 - "constantDay": "1",  
26 - "dateKey": "Today",  
27 - "signed": "true",  
28 - "today": "true",  
29 - "yohoCoinNum": "5"  
30 - },  
31 - {  
32 - "constantDay": "2",  
33 - "dateKey": "3.25",  
34 - "signed": "false",  
35 - "today": "false",  
36 - "yohoCoinNum": "10"  
37 - },  
38 - {  
39 - "constantDay": "3",  
40 - "dateKey": "3.26",  
41 - "signed": "false",  
42 - "today": "false",  
43 - "yohoCoinNum": "10"  
44 - },  
45 - {  
46 - "constantDay": "4",  
47 - "dateKey": "3.27",  
48 - "signed": "false",  
49 - "today": "false",  
50 - "yohoCoinNum": "15"  
51 - },  
52 - {  
53 - "constantDay": "5",  
54 - "dateKey": "3.28",  
55 - "signed": "false",  
56 - "today": "false",  
57 - "yohoCoinNum": "15"  
58 - },  
59 - {  
60 - "constantDay": "6",  
61 - "dateKey": "3.29",  
62 - "signed": "false",  
63 - "today": "false",  
64 - "yohoCoinNum": "20"  
65 - },  
66 - {  
67 - "constantDay": "7",  
68 - "dateKey": "3.30",  
69 - "signed": "false",  
70 - "today": "false",  
71 - "yohoCoinNum": "100"  
72 - }  
73 - ],  
74 - "todayCanGainYohoCoinNum": "5",  
75 - "todayKey": "3.24",  
76 - "todaySigned": "true",  
77 - "tomorrowCanGainYohoCoinNum": "10",  
78 - "totalYohoCoinNum": "5",  
79 - "uid": "213"  
80 - },  
81 - "md5": "7518388918692bfd92ea26f972fc89f7",  
82 - "message": "获取签到信息成功"  
83 -}  
84 -```  
85 -  
86 -## 2、用户签到接口##  
87 -  
88 -用户签到接口（method=app.sign.userSign）  
89 -#### 请求参数  
90 -| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |  
91 -|:-------| -----:|-----:|-----:|-----:|----:|  
92 -|uid|int|否|213|0|用户id|  
93 -  
94 -注意，通用的头部没有列出。  
95 -请求示例  
96 -http://192.168.102.217:8080/gateway/?method=app.sign.userSign&uid=213&debug=XYZ  
97 -  
98 -### 响应(data里所有的字段返回都是string类型)  
99 -code为200即为成功，否则是失败。  
100 -响应JSON格式如下所示:  
101 -```json  
102 -{  
103 - "code": 500,  
104 - "message": "用户已经签到过"  
105 -}  
106 -```  
107 -或者  
108 -```json  
109 -{  
110 - "alg": "SALT_MD5",  
111 - "code": 200,  
112 - "data": {  
113 - "gainYohoCoinNum": "5",  
114 - "totalYohoCoinNum": "5",  
115 - "uid": "215"  
116 - },  
117 - "md5": "01620cc59749b4a09571dad331136736",  
118 - "message": "用户签到成功"  
119 -}  
120 -```  
121 -  
122 -## 3、用户开启/关闭推送##  
123 -  
124 -用户开启/关闭推送（method=app.sign.changePushFlag）  
125 -#### 请求参数  
126 -| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |  
127 -|:-------| -----:|-----:|-----:|-----:|----:|  
128 -|uid|int|否|213|0|用户id|  
129 -|pushFlag|int|否|1|0|0:关闭推送1：开启推送|  
130 -  
131 -注意，通用的头部没有列出。  
132 -请求示例  
133 -http://192.168.102.217:8080/gateway/?method=app.sign.changePushFlag&uid=213&pushFlag=1&debug=XYZ  
134 -  
135 -### 响应  
136 -code为200即为成功，否则是失败。  
137 -响应JSON格式如下所示:  
138 -```json  
139 -{  
140 - "alg": "SALT_MD5",  
141 - "code": 200,  
142 - "data": [],  
143 - "md5": "6d729d4b35f10fc73531210bd7ecff91",  
144 - "message": "修改成功"  
145 -}  
146 -``` 1 +## 1、获取用户签到信息##
  2 +
  3 +获取用户签到信息（method=app.sign.userSignInfo）
  4 +#### 请求参数
  5 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|----:|
  7 +|uid|int|否|213|0|用户id|
  8 +
  9 +注意，通用的头部没有列出。
  10 +请求示例
  11 +http://192.168.102.217:8080/gateway/?method=app.sign.userSignInfo&uid=213&debug=XYZ
  12 +
  13 +### 响应(data里所有的字段返回都是string类型)
  14 +code为200即为成功，否则是失败。
  15 +响应JSON格式如下所示:
  16 +```json
  17 +{
  18 + "alg": "SALT_MD5",
  19 + "code": 200,
  20 + "data": {
  21 + "constantDay": "1",
  22 + "pushFlag": "1",
  23 + "signInfoList": [
  24 + {
  25 + "constantDay": "1",
  26 + "dateKey": "Today",
  27 + "signed": "true",
  28 + "today": "true",
  29 + "yohoCoinNum": "5"
  30 + },
  31 + {
  32 + "constantDay": "2",
  33 + "dateKey": "3.25",
  34 + "signed": "false",
  35 + "today": "false",
  36 + "yohoCoinNum": "10"
  37 + },
  38 + {
  39 + "constantDay": "3",
  40 + "dateKey": "3.26",
  41 + "signed": "false",
  42 + "today": "false",
  43 + "yohoCoinNum": "10"
  44 + },
  45 + {
  46 + "constantDay": "4",
  47 + "dateKey": "3.27",
  48 + "signed": "false",
  49 + "today": "false",
  50 + "yohoCoinNum": "15"
  51 + },
  52 + {
  53 + "constantDay": "5",
  54 + "dateKey": "3.28",
  55 + "signed": "false",
  56 + "today": "false",
  57 + "yohoCoinNum": "15"
  58 + },
  59 + {
  60 + "constantDay": "6",
  61 + "dateKey": "3.29",
  62 + "signed": "false",
  63 + "today": "false",
  64 + "yohoCoinNum": "20"
  65 + },
  66 + {
  67 + "constantDay": "7",
  68 + "dateKey": "3.30",
  69 + "signed": "false",
  70 + "today": "false",
  71 + "yohoCoinNum": "100"
  72 + }
  73 + ],
  74 + "todayCanGainYohoCoinNum": "5",
  75 + "todayKey": "3.24",
  76 + "todaySigned": "true",
  77 + "tomorrowCanGainYohoCoinNum": "10",
  78 + "totalYohoCoinNum": "5",
  79 + "uid": "213"
  80 + },
  81 + "md5": "7518388918692bfd92ea26f972fc89f7",
  82 + "message": "获取签到信息成功"
  83 +}
  84 +```
  85 +
  86 +## 2、用户签到接口##
  87 +
  88 +用户签到接口（method=app.sign.userSign）
  89 +#### 请求参数
  90 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  91 +|:-------| -----:|-----:|-----:|-----:|----:|
  92 +|uid|int|否|213|0|用户id|
  93 +
  94 +注意，通用的头部没有列出。
  95 +请求示例
  96 +http://192.168.102.217:8080/gateway/?method=app.sign.userSign&uid=213&debug=XYZ
  97 +
  98 +### 响应(data里所有的字段返回都是string类型)
  99 +code为200即为成功，否则是失败。
  100 +响应JSON格式如下所示:
  101 +```json
  102 +{
  103 + "code": 500,
  104 + "message": "用户已经签到过"
  105 +}
  106 +```
  107 +或者
  108 +```json
  109 +{
  110 + "alg": "SALT_MD5",
  111 + "code": 200,
  112 + "data": {
  113 + "gainYohoCoinNum": "5",
  114 + "totalYohoCoinNum": "5",
  115 + "uid": "215"
  116 + },
  117 + "md5": "01620cc59749b4a09571dad331136736",
  118 + "message": "用户签到成功"
  119 +}
  120 +```
  121 +
  122 +## 3、用户开启/关闭推送##
  123 +
  124 +用户开启/关闭推送（method=app.sign.changePushFlag）
  125 +#### 请求参数
  126 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  127 +|:-------| -----:|-----:|-----:|-----:|----:|
  128 +|uid|int|否|213|0|用户id|
  129 +|pushFlag|int|否|1|0|0:关闭推送1：开启推送|
  130 +|token|String|是|119de066edf16ec35efbebc19df903b7|空|IOS或者安卓的设备token|
  131 +
  132 +注意，通用的头部没有列出。
  133 +请求示例
  134 +http://192.168.102.217:8080/gateway/?method=app.sign.changePushFlag&uid=213&pushFlag=1&token=119de066edf16ec35efbebc19df903b7&debug=XYZ
  135 +
  136 +### 响应
  137 +code为200即为成功，否则是失败。
  138 +响应JSON格式如下所示:
  139 +```json
  140 +{
  141 + "alg": "SALT_MD5",
  142 + "code": 200,
  143 + "data": [],
  144 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  145 + "message": "修改成功"
  146 +}
  147 +```