add optimize brand search api doc
Showing
1 changed file
with
139 additions
and
0 deletions
商品列表/brandSearch.md
0 → 100644
1 | +##热搜品牌列表接口## | ||
2 | + | ||
3 | +(method=web.brand.byDomain) | ||
4 | +#### 请求参数 | ||
5 | +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | | ||
6 | +|:-------| -----:|-----:|-----:|-----:|----:| | ||
7 | + | ||
8 | + | ||
9 | +注意,通用的头部没有列出。 | ||
10 | +请求示例 | ||
11 | +http://devapi.yoho.cn:58078/?debug=XYZ&app_version=3.8.2&client_type=android&os_version=yohobuy%3Ah5&screen_size=720x1280&v=7&method=app.search.hotBrands | ||
12 | + | ||
13 | +### 响应 | ||
14 | +code为200即为成功,否则是失败。 | ||
15 | +响应JSON格式如下所示: | ||
16 | +```json | ||
17 | +{ | ||
18 | + "code": 200, | ||
19 | + "data": { | ||
20 | + "list": [ | ||
21 | + { | ||
22 | + "brandId": 1616, --品牌id | ||
23 | + "brandName": "12", --品牌名 | ||
24 | + "createTime": 1462954166, | ||
25 | + "creatorId": 2794, | ||
26 | + "creatorName": "wxtest1", | ||
27 | + "id": 12, | ||
28 | + "modifyId": 2794, | ||
29 | + "modifyName": "wxtest1", | ||
30 | + "modifyTime": 1462954760, | ||
31 | + "orderBy": 12123, --排序 | ||
32 | + "status": 0 | ||
33 | + }, | ||
34 | + { | ||
35 | + "brandId": 1616, | ||
36 | + "brandName": "12", | ||
37 | + "createTime": 1462954132, | ||
38 | + "creatorId": 2794, | ||
39 | + "creatorName": "wxtest1", | ||
40 | + "id": 10, | ||
41 | + "modifyId": 2794, | ||
42 | + "modifyName": "wxtest1", | ||
43 | + "modifyTime": 1462954185, | ||
44 | + "orderBy": 1123, | ||
45 | + "status": 0 | ||
46 | + }, | ||
47 | + { | ||
48 | + "brandId": 1632, | ||
49 | + "brandName": "test1", | ||
50 | + "createTime": 1462954329, | ||
51 | + "creatorId": 0, | ||
52 | + "id": 14, | ||
53 | + "modifyId": 2794, | ||
54 | + "modifyName": "wxtest1", | ||
55 | + "modifyTime": 1462954765, | ||
56 | + "orderBy": 122, | ||
57 | + "status": 0 | ||
58 | + }, | ||
59 | + { | ||
60 | + "brandId": 1654, | ||
61 | + "brandName": "1", | ||
62 | + "createTime": 1462953863, | ||
63 | + "creatorId": 2794, | ||
64 | + "creatorName": "wxtest1", | ||
65 | + "id": 8, | ||
66 | + "modifyId": 0, | ||
67 | + "modifyTime": 0, | ||
68 | + "orderBy": 2, | ||
69 | + "status": 0 | ||
70 | + } | ||
71 | + ], | ||
72 | + "page": 1, | ||
73 | + "size": 10, | ||
74 | + "total": 4, | ||
75 | + "totalPage": 1 | ||
76 | + }, | ||
77 | + "md5": "d4d43382e074027624d686bc8b909a93", | ||
78 | + "message": "查询品牌热搜词成功" | ||
79 | +} | ||
80 | + | ||
81 | +``` | ||
82 | + | ||
83 | +## 2、查询搜索品牌历史记录接口## | ||
84 | + | ||
85 | +(method=web.brand.folder) | ||
86 | +#### 请求参数 | ||
87 | +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | | ||
88 | +|:-------| -----:|-----:|-----:|-----:|----:| | ||
89 | +|uid|int|是|248|0|用户id| | ||
90 | +|records|String[]| 否|["18923_adidas","183323_nike"]|-|状态| | ||
91 | + | ||
92 | +注意,通用的头部没有列出。 | ||
93 | +请求示例 | ||
94 | +http://devapi.yoho.cn:58078/?debug=XYZ&app_version=3.8.2&client_type=android&os_version=yohobuy%3Ah5&screen_size=720x1280&v=7&method=app.search.hotBrandRecords&debug=XYZ&uid=9999&records | ||
95 | +### 响应 | ||
96 | +code为200即为成功,否则是失败。 | ||
97 | +响应JSON格式如下所示: | ||
98 | +```json | ||
99 | +{ | ||
100 | + "alg": "SALT_MD5", | ||
101 | + "code": 200, | ||
102 | + "data": [ | ||
103 | + { | ||
104 | + "searchTerms": "test-chen", --品牌 | ||
105 | + "searchTime": 1452043863 --时间戳 | ||
106 | + }, | ||
107 | + { | ||
108 | + "searchTerms": "test-cc", | ||
109 | + "searchTime": 1452043873 | ||
110 | + } | ||
111 | +], | ||
112 | + "md5": "e24c0c724646c486236bf24b7cb2a9a5", | ||
113 | + "message": "success" | ||
114 | +} | ||
115 | +``` | ||
116 | + | ||
117 | +## 3、清理品牌历史## | ||
118 | + | ||
119 | +(method=web.brand.series) | ||
120 | +#### 请求参数 | ||
121 | +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | | ||
122 | +|:-------| -----:|-----:|-----:|-----:|----:| | ||
123 | +|uid|int|是|248|0|用户id| | ||
124 | + | ||
125 | +注意,通用的头部没有列出。 | ||
126 | +请求示例 | ||
127 | +http://devapi.yoho.cn:58078/?debug=XYZ&app_version=3.8.2&client_type=android&os_version=yohobuy%3Ah5&screen_size=720x1280&v=7&method=app.search.clearHotBrandRecords&debug=XYZ&uid=9999 | ||
128 | +### 响应 | ||
129 | +code为200即为成功,否则是失败。 | ||
130 | +响应JSON格式如下所示: | ||
131 | +```json | ||
132 | +{ | ||
133 | + "alg": "SALT_MD5", | ||
134 | + "code": 200, | ||
135 | + | ||
136 | + "md5": "89445294eb4487a1233cff63b1df01e7", | ||
137 | + "message": "brand info" | ||
138 | +} | ||
139 | +``` |
-
Please register or login to post a comment