ttj1314 / API-Interfaces · Commits

Go to a project

Authored by henry
Commit 2af022e0c427b4f11429f6a0afdaed36aca994a4 1 parent 494b13c3

11

Inline Side-by-side
Showing 1 changed file with 0 additions and 339 deletions
1 -新潮教室签到  
2 -------------  
3 -  
4 -## 1. 获取当前用户亲密度，排名  
5 -  
6 -`method=app.starClass.rankInfo`  
7 -  
8 -#### 入参  
9 -  
10 -| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |  
11 -|:---------|---------:|----------:|-----:|-------:|-----:|  
12 -| method | string | 否 | app.starClass.rankInfo |||  
13 -| uid | int | 否 | 213 | 0 |用户id|  
14 -  
15 -#### 出参  
16 -  
17 -```json  
18 -{  
19 - "alg": "SALT_MD5",  
20 - "code": 200,  
21 - "data": {  
22 - // 如果没有签过到，会显示零  
23 - "userNum": 10,  
24 - // 如果没有签过到，会没有数据  
25 - "userRank": 2  
26 - },  
27 - "md5": "fcf7791bac08abb80ef3a2b27964386c",  
28 - "message": "获取用户亲密度成功"  
29 -}  
30 -```  
31 -  
32 -### 错误码  
33 -  
34 -| 错误码 code | message | 说明 |  
35 -|-------------|---------|------|  
36 -| 200 | success | |  
37 -| 400 | 输入参数错误 | 没传 uid |  
38 -| 500 | 获取个人排名失败 | uid 不存在或者查询 redis 失败 |  
39 -  
40 -## 2.签到  
41 -  
42 -`method=app.starClass.sign`  
43 -  
44 -#### 入参  
45 -  
46 -| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |  
47 -|:---------|---------:|----------:|-----:|-------:|-----:|  
48 -| method | string | 否 | app.starClass.sign |||  
49 -| uid | int | 否 | 213 | 0 |用户id|  
50 -  
51 -#### 出参  
52 -  
53 -```json  
54 -{  
55 - "alg": "SALT_MD5",  
56 - "code": 200,  
57 - "data": {  
58 - // 本次增加的亲密度  
59 - "addNum": 10,  
60 - // 签到记录  
61 - "logs": [  
62 - {  
63 - "addNum": 10,  
64 - "createTime": 1460112775,  
65 - "id": 211,  
66 - "starId": 1,  
67 - "type": 1,  
68 - "uid": 3703860  
69 - }  
70 - ],  
71 - // 前三名  
72 - "rankList": [  
73 - {  
74 - "num": 10,  
75 - "uid": 3566199,  
76 - "username": "136****8114@yohoinc.com"  
77 - },  
78 - {  
79 - "avatar": "http://static.yoho.cn/images/default_userhead_boy_180_180.png?imageView/{mode}/w/{width}/h/{height}",  
80 - "num": 10,  
81 - "uid": 3566423,  
82 - "username": "黄德才"  
83 - },  
84 - {  
85 - "avatar": "http://static.yoho.cn/images/default_userhead_boy_180_180.png?imageView/{mode}/w/{width}/h/{height}",  
86 - "num": 10,  
87 - "uid": 3703860,  
88 - "username": "曹苒"  
89 - }  
90 - ]  
91 - },  
92 - "md5": "450edbd92076dfac74701cb6421f68ae",  
93 - "message": "获取用户签到信息成功"  
94 -}  
95 -```  
96 -  
97 -### 错误码  
98 -  
99 -| 错误码 code | message | 说明 |  
100 -|-------------|---------|------|  
101 -| 200 | success | |  
102 -| 400 | 输入参数错误 | 没传 uid |  
103 -| 500 | 设置 redis 失败 | 比如 redis 挂了等情况 |  
104 -  
105 -## 3.转发  
106 -  
107 -`method=app.starClass.forward`  
108 -  
109 -#### 入参  
110 -  
111 -| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |  
112 -|:---------|---------:|----------:|-----:|-------:|-----:|  
113 -| method | string | 否 | app.starClass.forward |||  
114 -| uid | int | 否 | 213 | 0 |用户id|  
115 -  
116 -#### 出参  
117 -  
118 -```json  
119 -{  
120 - "alg": "SALT_MD5",  
121 - "code": 200,  
122 - "data": 10, // 本次增加的分数  
123 - "md5": "9f6ed5823862ae9009fc8084516132da",  
124 - "message": "用户转发"  
125 -}  
126 -```  
127 -  
128 -### 错误码  
129 -  
130 -| 错误码 code | message | 说明 |  
131 -|-------------|---------|------|  
132 -| 200 | success | |  
133 -| 400 | 输入参数错误 | 没传 uid |  
134 -| 500 | 设置 redis 失败 | 比如 redis 挂了等情况 |  
135 -  
136 -## 前 100  
137 -  
138 -`method=app.starClass.top100`  
139 -  
140 -| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |  
141 -|:---------|---------:|----------:|-----:|-------:|-----:|  
142 -| method | string | 否 | app.starClass.top100 |||  
143 -| uid | int | 是 | 213 | 0 |用户id|  
144 -  
145 -#### 出参  
146 -  
147 -```json  
148 -{  
149 - "alg": "SALT_MD5",  
150 - "code": 200,  
151 - "data": {  
152 - "top": [  
153 - {  
154 - "avatar": "http://static.yoho.cn/images/default_userhead_boy_180_180.png?imageView/{mode}/w/{width}/h/{height}",  
155 - "num": 20,  
156 - "uid": 3703860,  
157 - "username": "曹苒"  
158 - },  
159 - {  
160 - "avatar": "",  
161 - "num": 10,  
162 - "uid": 3566199,  
163 - "username": "136****8114@yohoinc.com"  
164 - },  
165 - {  
166 - "avatar": "http://static.yoho.cn/images/default_userhead_boy_180_180.png?imageView/{mode}/w/{width}/h/{height}",  
167 - "num": 10,  
168 - "uid": 3566423,  
169 - "username": "黄德才"  
170 - },  
171 - {  
172 - "avatar": "",  
173 - "num": 10,  
174 - "uid": 967016,  
175 - "username": "goodboy"  
176 - },  
177 - {  
178 - "avatar": "",  
179 - "num": 10,  
180 - "uid": 8041520,  
181 - "username": "朱少卿"  
182 - }  
183 - ],  
184 - "userStarInfo": {  
185 - "userNum": 10,  
186 - "userRank": 5,  
187 - "username": "朱少卿"  
188 - }  
189 - },  
190 - "md5": "7085123ec3516d4d9ce60c6001407596",  
191 - "message": "top100"  
192 -}  
193 -```  
194 -  
195 -### 错误码  
196 -  
197 -| 错误码 code | message | 说明 |  
198 -|-------------|---------|------|  
199 -| 200 | success | |  
200 -| 500 | 查询 redis 失败 | 比如 redis 挂了等情况 |  
201 -  
202 -## 4.获得星潮教室中星搭配的文章  
203 -星搭配文章取逛后台新增的标签分类‘星潮教室’，标签开启状态下的文章（/guang/api/*/article/getStarClassroomArticleList）（app接口）  
204 -  
205 -| 接口说明 | 接口说明 |  
206 -|:------- | -----:|  
207 -|请求域名 | http://api.yoho.cn/ |  
208 -|接口名 | /guang/api/*/article/getStarClassroomArticleList |  
209 -|接口说明 | 获得星潮教室中星搭配的文章 |  
210 -|接口说明 | get |  
211 -  
212 -#### 请求参数  
213 -  
214 -| 参数名称 | 参数类型 | 长度 | 是否必须 | 示例值 | 默认值 | 描述 |  
215 -|:---------| --------:|-----:| ---------:| ------:| ------:| ----:|  
216 -|page|Integer|3|否|1|1|页码|  
217 -  
218 -#### 正常返回结果  
219 -  
220 -```json  
221 -{  
222 - "alg": "SALT_MD5",  
223 - "code": 200,  
224 - "data": {  
225 - "datetime": "1460342224",  
226 - "list": {  
227 - "artList": [  
228 - {  
229 - "ads_img_size": "",  
230 - "article_type": "1",  
231 - "author": {  
232 - "author_id": "5105041",  
233 - "avatar": "http://img12.static.yhbimg.com/yhb-img02/2015/06/15/14/02e77877049e6949eb5e8b121b6f58204d.jpg?imageView/0/w/100/h/100",  
234 - "name": "雷恩雷恩",  
235 - "url": "http://guang.m.yohobuy.com/author/index?id=5105041&openby:yohobuy={\"action\":\"go.h5\",\"params\":{\"param\":{\"id\":\"5105041\"},\"share\":\"\",\"id\":5105041,\"type\":0,\"islogin\":\"N\",\"url\":\"http://guang.m.yohobuy.com/author/index\"}}"  
236 - },  
237 - "author_id": "5105041",  
238 - "category_id": "1",  
239 - "category_name": "话题",  
240 - "conver_image_type": "2",  
241 - "id": 29630,  
242 - "intro": "Wuli凡凡前天回广州老家，小蛮腰可是为他亮起了欢迎语~这阵仗，简直了。看来《老炮儿》和wuli凡凡的人气，实在是高的不要不要。~",  
243 - "isFavor": "N",  
244 - "isPraise": "N",  
245 - "is_recommended": "0",  
246 - "praiseStatus": "true",  
247 - "praise_num": "46",  
248 - "publish_time": "12月25日 22:00",  
249 - "share": {  
250 - "url": "http://guang.m.yohobuy.com/info/index?id=29630&openby:yohobuy={\"action\":\"go.share\",\"params\":{\"pic\":\"http://img11.static.yhbimg.com/yhb-img01/2015/12/25/10/014df3a77aad110a75f4c63865461785da.jpg?imageView/2/w/640/h/640\",\"title\":\"《老炮儿》造型大吐槽！吴亦凡李易峰戏里戏外造型PK！\",\"url\":\"http://guang.m.yohobuy.com/info/index?id=29630\",\"content\":\"潮流资讯，新鲜贩售，YOHO!有货【逛】不停\"}}"  
251 - },  
252 - "src": "http://img11.static.yhbimg.com/yhb-img01/2015/12/25/10/014df3a77aad110a75f4c63865461785da.jpg?imageView/{mode}/w/{width}/h/{height}",  
253 - "title": "《老炮儿》造型大吐槽！吴亦凡李易峰戏里戏外造型PK！",  
254 - "url": "http://guang.m.yohobuy.com/info/index?id=29630&openby:yohobuy={\"action\":\"go.h5\",\"params\":{\"param\":{\"id\":\"29630\"},\"update_flag\":\"a585b3d889ca39701f76149e194ae268\",\"shareparam\":{\"id\":29630},\"share\":\"/guang/api/v1/share/guang\",\"id\":29630,\"type\":1,\"url\":\"http://guang.m.yohobuy.com/info/index\",\"islogin\":\"N\"}}",  
255 - "views_num": "57133"  
256 - },  
257 - {  
258 - "article_type": "1",  
259 - "author": {  
260 - "author_id": "5514979",  
261 - "avatar": "http://img12.static.yhbimg.com/yhb-img02/2015/06/12/15/025ff50f6d72fd19abe00c1bc3f0576eaa.jpg?imageView/0/w/100/h/100",  
262 - "name": "XpecialSux",  
263 - "url": "http://guang.m.yohobuy.com/author/index?id=5514979&openby:yohobuy={\"action\":\"go.h5\",\"params\":{\"param\":{\"id\":\"5514979\"},\"share\":\"\",\"id\":5514979,\"type\":0,\"islogin\":\"N\",\"url\":\"http://guang.m.yohobuy.com/author/index\"}}"  
264 - },  
265 - "author_id": "5514979",  
266 - "category_id": "2",  
267 - "category_name": "搭配",  
268 - "conver_image_type": "1",  
269 - "id": 589,  
270 - "intro": "印象里松糕鞋总是女生的专属，殊不知，男生穿上松糕鞋同样也可以萌萌哒，简单的白色短袖T恤搭配迷彩短裤，原创的松糕鞋编织鞋头细节承载麂皮绒的特殊质感，表达年轻人拒绝平庸主义的态度。",  
271 - "isFavor": "N",  
272 - "isPraise": "N",  
273 - "is_recommended": "0",  
274 - "praiseStatus": "true",  
275 - "praise_num": "25",  
276 - "publish_time": "06月05日 16:10",  
277 - "share": {  
278 - "url": "http://guang.m.yohobuy.com/info/index?id=589&openby:yohobuy={\"action\":\"go.share\",\"params\":{\"pic\":\"http://img11.static.yhbimg.com/yhb-img01/2015/06/01/13/01c00f0fe35939d71161f98f4996dbe703.jpg?imageView/2/w/640/h/640\",\"title\":\"男生穿松糕鞋也可以萌萌哒\",\"url\":\"http://guang.m.yohobuy.com/info/index?id=589\",\"content\":\"潮流资讯，新鲜贩售，YOHO!有货【逛】不停\"}}"  
279 - },  
280 - "src": "http://img11.static.yhbimg.com/yhb-img01/2015/06/01/13/01c00f0fe35939d71161f98f4996dbe703.jpg?imageView/{mode}/w/{width}/h/{height}",  
281 - "title": "男生穿松糕鞋也可以萌萌哒",  
282 - "url": "http://guang.m.yohobuy.com/info/index?id=589&openby:yohobuy={\"action\":\"go.h5\",\"params\":{\"param\":{\"id\":\"589\"},\"update_flag\":\"5b9724501839dfbe5ffcc00201868dc0\",\"shareparam\":{\"id\":589},\"share\":\"/guang/api/v1/share/guang\",\"id\":589,\"type\":1,\"url\":\"http://guang.m.yohobuy.com/info/index\",\"islogin\":\"N\"}}",  
283 - "views_num": "25960"  
284 - }  
285 - ]  
286 - },  
287 - "page": 1,  
288 - "total": 2,  
289 - "totalPage": 1  
290 - },  
291 - "md5": "6b2878c28018dbae9435cdc49a019e3e",  
292 - "message": "星潮教室文章列表"  
293 -}  
294 -```  
295 -#### 响应内容描述  
296 -| Param Name | Param Type | Desc |  
297 -|:---------| --------:|-----:|  
298 -|alg |String | |  
299 -|code |int |状态码 |  
300 -|md5 |String | |  
301 -|message |String |返回结果内容描述 |  
302 -|data |json |返回数据内容 |  
303 -|datetime |String |当前时间 |  
304 -|page |int |当前页 |  
305 -|total |int |总记录数 |  
306 -|totalPage |int |总页数 |  
307 -|list |json |文章集合对象 |  
308 -|artList |array |文章数组 |  
309 -|ads_img_size |String |广告图片尺寸 |  
310 -|article_type |String |文章类型 |  
311 -|author_id |String |作者ID |  
312 -|author |json |作者对象json |  
313 -|author_id |String |作者ID |  
314 -|avatar |String |产品的图片URL |  
315 -|name |String |名称 |  
316 -|url |String |链接的地址 |  
317 -|category_id |String |分类ID |  
318 -|category_name |String |分类名称 |  
319 -|conver_image_type |String |图片类型 1方图,2长图 |  
320 -|id |String | |  
321 -|intro |String |文章信息 |  
322 -|isFavor |String |是否收藏 |  
323 -|isPraise |String |是否点赞 |  
324 -|is_recommended |String |是否推荐 |  
325 -|praiseStatus |String |点赞状态 |  
326 -|praise_num |String |点赞数量 |  
327 -|publish_time |String |发布时间 |  
328 -|share |json |分享链接 |  
329 -|url |String |分享链接地址 |  
330 -|src |String |图片绝对路径 |  
331 -|title |String |文章标题 |  
332 -|url |String |URL |  
333 -|views_num |String |查看数量 |  
334 -  
335 -  
336 -#### 异常返回结果：  
337 -| 错误码code | 错误message | 说明 |  
338 -|:---------| --------:|-----:|  
339 -| 500| | 内部错误|