匡佳华 / API-Interfaces · Commits

Go to a project

Authored by liyalin
Commit db5a32a45de42a1232abbd1c80e7bf66d439ab0a 2 parents 76df9cf4 8480db0f

Merge branch 'master' of http://git.yoho.cn/yoho-documents/api-interfaces

Inline Side-by-side
Showing 1 changed file with 239 additions and 0 deletions
  1 +## 1、店铺推广列表##
  2 +
  3 +（method=app.shops.promote）
  4 +请求方式：get
  5 +#### 请求参数
  6 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  7 +|:-------| -----:|-----:|-----:|-----:|----:|
  8 +|channel_id|Integer| 是| 1|null|频道|
  9 +|tab_name|String| 是| promotion|null|tab名称|
  10 +|app_type|int|是|null|0|客户端类型 0：有货 1：BLK|
  11 +
  12 +
  13 +注意，通用的头部没有列出。
  14 +请求示例
  15 +http://192.168.102.205:8080//gateway/?app_version=4.9.2&client_type=h5&method=app.shops.promote&os_version=yohobuy%3Ah5&screen_size=720x1280&session_key=&debug=XYZ&channel_id=0&tab_name=%E7%83%AD%E9%97%A8%E6%8E%A8%E8%8D%90&uid=9963947&v=7&client_secret=420eeac80e35c7d5b2e1916a458fa5c3
  16 +### 响应
  17 +code为200即为成功且只会返回200，每次都会有响应结果。
  18 +响应JSON格式如下所示:
  19 +```json
  20 +{
  21 + "alg": "SALT_MD5",
  22 + "code": 200,
  23 + "data": [
  24 + {
  25 + "bannerUrl": "http://img12.static.yhbimg.com/yhb-img01/2016/04/14/03/0256bccd2c0b8568d6c1b076b15118a95e.jpg",
  26 + "channelId": 0,
  27 + "collectionNum": 8,
  28 + "id": 580,
  29 + "logoUrl": "http://img10.static.yhbimg.com/brandLogo/2015/12/03/15/0143d55131211e652757eb714f52d20cd5.jpg",
  30 + "shopName": "大神+其他的多品店",
  31 + "shopTemplateType": "1",
  32 + "shopsId": 824,
  33 + "tabName": "热门推荐",
  34 + "words": "adfddfas"
  35 + },
  36 + {
  37 + "bannerUrl": "http://img12.static.yhbimg.com/yhb-img01/2016/04/14/02/0288aa42523cc8b68f2a765226f5675324.jpg",
  38 + "channelId": 0,
  39 + "collectionNum": 5,
  40 + "id": 588,
  41 + "logoUrl": "http://img12.static.yhbimg.com/brandLogo/2015/12/14/17/02644a0fa81cca0597c977064443e18e37.png",
  42 + "shopName": "红妆的店铺",
  43 + "shopTemplateType": "2",
  44 + "shopsId": 756,
  45 + "tabName": "热门推荐",
  46 + "words": "发送到阿范德萨"
  47 + },
  48 + {
  49 + "bannerUrl": "http://img12.static.yhbimg.com/yhb-img01/2016/04/14/02/02e571f06b29632925b2a601ed26f98580.jpg",
  50 + "channelId": 0,
  51 + "collectionNum": 78,
  52 + "id": 590,
  53 + "logoUrl": "http://img12.static.yhbimg.com/brandLogo/2015/12/08/13/024f3422bb5119ba766e44d97631c5b351.jpg",
  54 + "shopName": "YOHOOD",
  55 + "shopTemplateType": "2",
  56 + "shopsId": 720,
  57 + "tabName": "热门推荐",
  58 + "words": "发生的个"
  59 + },
  60 + {
  61 + "bannerUrl": "http://img12.static.yhbimg.com/yhb-img01/2016/04/14/03/026b13169701d618595aae76db8189f27d.jpg",
  62 + "channelId": 0,
  63 + "collectionNum": 7,
  64 + "id": 592,
  65 + "logoUrl": "http://img10.static.yhbimg.com/brandLogo/2016/01/18/15/01a44fda485dffef2a25c6082aa7ead968.jpg",
  66 + "shopName": "多品店0829",
  67 + "shopTemplateType": "1",
  68 + "shopsId": 776,
  69 + "tabName": "热门推荐",
  70 + "words": "飞脚后跟"
  71 + },
  72 + {
  73 + "bannerUrl": "http://img12.static.yhbimg.com/yhb-img01/2016/04/14/03/0237c28bc07ac3d0c7eb1550444fb66662.jpg",
  74 + "channelId": 0,
  75 + "collectionNum": 35,
  76 + "id": 594,
  77 + "logoUrl": "http://img10.static.yhbimg.com/brandLogo/2016/03/09/09/01712331c2ab3f805a7ddd3eb95a35ac3f.jpg",
  78 + "shopName": "这里是店铺名称",
  79 + "shopTemplateType": "1",
  80 + "shopsId": 754,
  81 + "tabName": "热门推荐",
  82 + "words": "飞脚后跟"
  83 + },
  84 + {
  85 + "bannerUrl": "http://img12.static.yhbimg.com/yhb-img01/2016/04/14/03/02a8448fc6047625c437d39f7d00e401bf.jpg",
  86 + "channelId": 0,
  87 + "collectionNum": 13,
  88 + "id": 596,
  89 + "logoUrl": "http://img12.static.yhbimg.com/brandLogo/2016/03/10/02/02b39fad4583f6a06218eb58d879c2a3a9.png",
  90 + "shopName": "海澜之家",
  91 + "shopTemplateType": "1",
  92 + "shopsId": 702,
  93 + "tabName": "热门推荐",
  94 + "words": "是大法官"
  95 + },
  96 + {
  97 + "bannerUrl": "http://img12.static.yhbimg.com/yhb-img01/2016/04/14/03/02137e5cbcd5336c831550939ca70ba9a5.jpg",
  98 + "channelId": 0,
  99 + "collectionNum": 16,
  100 + "id": 598,
  101 + "logoUrl": "http://img11.static.yhbimg.com/brandLogo/2016/03/21/03/016ac3a07b727c0720bb510d24c577e885.png",
  102 + "shopName": "海绵宝宝22",
  103 + "shopTemplateType": "1",
  104 + "shopsId": 686,
  105 + "tabName": "热门推荐",
  106 + "words": "双方各"
  107 + }
  108 + ],
  109 + "md5": "08ec4fb8e05e4bc2617fd89bdf1793f8",
  110 + "message": "product shopsPromote Info"
  111 +}
  112 +```
  113 +
  114 +
  115 +## 2、收藏店铺接口##
  116 +
  117 +（method=app.favorite.add）
  118 +#### 请求参数
  119 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  120 +|:-------| -----:|-----:|-----:|-----:|----:|
  121 +|id|int|否|323|0|店铺id|
  122 +|fav_id|int|否|323|0|店铺id|
  123 +|type|string|否|shop|0|收藏的类型，brand、product、shop|
  124 +|gender|string|是|1,3|无|性别|
  125 +|uid|int|否|9963947|无|uid别|
  126 +
  127 +注意，通用的头部没有列出，同原来收藏品牌接口。
  128 +请求示例
  129 +http://devapi.yoho.cn:58078/?fav_id=356&gender=1%2C3&id=356&method=app.favorite.add&type=shop&uid=9963947&v=7&yh_channel=1&debug=XYZ
  130 +### 响应
  131 +code为200即为成功，否则是失败。
  132 +响应JSON格式如下所示:
  133 +```json
  134 +{
  135 + "alg": "SALT_MD5",
  136 + "code": 200,
  137 + "data": {
  138 + "fav_id": 3030477
  139 + },
  140 + "md5": "8cd05100f51bdaed7fd4380e71e3af5b",
  141 + "message": "收藏成功"
  142 +}
  143 +```
  144 +
  145 +
  146 +## 3、取消收藏店铺接口##
  147 +
  148 +（method=app.favorite.cancel）
  149 +#### 请求参数
  150 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  151 +|:-------| -----:|-----:|-----:|-----:|----:|
  152 +|id|int|否|323|0|店铺id|
  153 +|fav_id|int|否|323|0|店铺id|
  154 +|type|string|否|shop|0|收藏的类型，brand、product、shop|
  155 +|gender|string|是|1,3|无|性别|
  156 +|uid|int|否|9963947|无|uid别|
  157 +
  158 +注意，通用的头部没有列出，同原来取消收藏品牌接口。
  159 +请求示例
  160 +http://devapi.yoho.cn:58078/?fav_id=356&gender=1%2C3&id=356&method=app.favorite.cancel&type=shop&uid=9963947&v=7&yh_channel=1&debug=XYZ
  161 +### 响应
  162 +code为200即为成功，否则是失败。
  163 +响应JSON格式如下所示:
  164 +```json
  165 +{
  166 + "alg": "SALT_MD5",
  167 + "code": 200,
  168 + "data": {
  169 + "fav_id": 3030477
  170 + },
  171 + "md5": "8cd05100f51bdaed7fd4380e71e3af5b",
  172 + "message": "取消收藏成功"
  173 +}
  174 +```
  175 +
  176 +
  177 +## 4、标签名称列表##
  178 +
  179 +（method=app.shops.promoteTabNameList）
  180 +请求方式：get
  181 +#### 请求参数
  182 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  183 +|:-------| -----:|-----:|-----:|-----:|----:|
  184 +|channel_id|Integer| 是| 1|null|频道|
  185 +
  186 +
  187 +注意，通用的头部没有列出。
  188 +请求示例
  189 +http://192.168.102.205:8080/gateway/?app_version=4.9.2&client_type=h5&client_secret=420eeac80e35c7d5b2e1916a458fa5c3?app_version=4.9.2&client_type=h5&channel_id=3&method=app.shops.promoteTabNameList&debug=XYZ&client_secret=420eeac80e35c7d5b2e1916a458fa5c3
  190 +### 响应
  191 +code为200即为成功且只会返回200，每次都会有响应结果。
  192 +响应JSON格式如下所示:
  193 +```json
  194 +{
  195 + "alg": "SALT_MD5",
  196 + "code": 200,
  197 + "data": [
  198 + "热门推荐",
  199 + "promotion"
  200 + ],
  201 + "md5": "eb62816ee03f53175c4b012388c2c98d",
  202 + "message": "product shopsPromote Info"
  203 +}
  204 +```
  205 +
  206 +
  207 +## 5、根据店铺ID和用户ID查询是否收藏##
  208 +
  209 +（method=app.shops.promoteFavorite）
  210 +#### 请求参数
  211 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  212 +|:-------| -----:|-----:|-----:|-----:|----:|
  213 +|shop_ids|String|否|323|0|店铺id,用,号隔开|
  214 +|uid|int|否|9963947|无|uid别|
  215 +
  216 +注意，通用的头部没有列出，同原来取消收藏品牌接口。
  217 +请求示例
  218 +http://172.16.6.157:8080/gateway/?app_version=4.9.2&client_type=h5&method=app.shops.promoteFavorite&uid=9963947&shop_ids=650,651&client_secret=420eeac80e35c7d5b2e1916a458fa5c3
  219 +### 响应
  220 +code为200即为成功，否则是失败。
  221 +响应JSON格式如下所示:
  222 +```json
  223 +{
  224 + "alg": "SALT_MD5",
  225 + "code": 200,
  226 + "data": [
  227 + {
  228 + "favorite": true,
  229 + "id": 650
  230 + },
  231 + {
  232 + "favorite": false,
  233 + "id": 651
  234 + }
  235 + ],
  236 + "md5": "69bf24b92c3be8ddd2f66f8d56f74642",
  237 + "message": "product shopspromoteFavorite Info"
  238 +}
  239 +```