mobile / MarketApi · Commits

Go to a project

Authored by 陈林
Commit 91bd08e4c9b7d1af8880b84d936f8cbf9a06caaa 1 parent f7e908d0

初始化了接口文档。

Inline Side-by-side
Showing 1 changed file with 342 additions and 1 deletions
1 -UFO 接口  
  1 +## 业务模块
  2 +
  3 +#### 1、首页
  4 +#####     1.1、首页资源位接口（优先级：高）
  5 + #### 2、商品列表
  6 +#####     2.1 首页商品列表（优先级：高）
  7 +######     2.2 搜索商品列表（优先级：中）
  8 +######     2.3 搜索商品列表（优先级：中）
  9 +######     2.4 获取筛选数据（优先级：中）
  10 +######     2.5 品类商品列表（优先级：中）
  11 +######     2.6 品牌商品列表（优先级：中）
  12 +######     2.7 收藏商品列表（优先级：中）
  13 + #### 3、商品详情页
  14 +#####     3.1、获取商品详情信息（优先级：高）
  15 +#####     3.2、获取商品详情推荐商品（优先级：高）
  16 +#####     3.3、获取尺码信息（优先级：高）
  17 + #### 4、卖家出售商品
  18 +#####     4.1 实名认证（优先级：高）
  19 +#####     4.2 获取出售商品信息（优先级：高）
  20 +#####     4.3 地址管理（优先级：高）
  21 +#####     4.4 地址新增（优先级：高）
  22 +#####     4.5 地址编辑（优先级：中）
  23 +#####     4.6 地址删除（优先级：中）
  24 +#####     4.7 支付保证金（优先级：高）
  25 + #### 5、品类、品牌
  26 +######     5.1 品类资源位（优先级：中）
  27 +######     5.2 品牌墙列表（优先级：中）
  28 + #### 6、消息
  29 +######     6.1 消息数字（优先级：低）
  30 +######     6.2 消息列表（优先级：中）
  31 + #### 7、我的
  32 +######     7.1 购买、出售、收藏数字（优先级：低）
  33 + #### 8、出售订单
  34 +#####     8.1 出售订单列表（优先级：高）
  35 +######     8.2 出售订单详情（优先级：中）
  36 +######     8.3 不卖了（操作）（优先级：中）
  37 +######     8.4 支付保证金（操作）（优先级：中）
  38 + #### 9、购买订单
  39 +
  40 +
  41 +
  42 +
  43 +<br>
  44 +## 接口参数说明
  45 +
  46 +### 1、首页
  47 +#### 1.1 首页资源位接口（优先级：高）
  48 +>访问地址：http://xxx.yoho.cn/xxxxxxx
  49 +
  50 +>接口示例：
  51 +
  52 +##### 请求参数
  53 +
  54 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  55 +|-------| -----|-----|-----|-----|----|
  56 +|content_code | string | 否 | xxxxxx | null | 资源位码 |
  57 +
  58 +
  59 +##### 返回字段说明
  60 +
  61 +|参数名 |值 |描述 |
  62 +|----------------|---- |--- |
  63 +|template_id | 12345 | 资源位楼层id |
  64 +|template_name | focus | 楼层类型，focus：轮播图；hotSeries：热门系列 |
  65 +|list | [{}] | 楼层数据 |
  66 +|&nbsp;&nbsp; src | http://img10.static.yhbimg.com/xxx | 图片地址 |
  67 +|&nbsp;&nbsp; title | asics | 标题 |
  68 +|&nbsp;&nbsp; url | http://xxx/openby={"action_type":"go.product"} | 跳转url |
  69 +
  70 +##### 响应JSON格式如下所示:
  71 +
  72 +```json
  73 +{
  74 + "alg": "SALT_MD5",
  75 + "code": 200,
  76 + "data": [
  77 + {
  78 + "template_id":123456,
  79 + "template_name":"focus",
  80 + "list":[
  81 + {
  82 + "src":"http://img10.static.yhbimg.com/xxx",
  83 + "title":"asics",
  84 + "url":"http://xxx/openby={"action_type":"go.product"}"
  85 + },
  86 + {
  87 + "src":"http://img10.static.yhbimg.com/xxx",
  88 + "title":"asics",
  89 + "url":"http://xxx/openby={"action_type":"go.product"}"
  90 + }
  91 + ]
  92 + },
  93 + {
  94 + "template_id":123456,
  95 + "template_name":"hotSeries",
  96 + "list":[
  97 + {
  98 + "src":"http://img10.static.yhbimg.com/xxx",
  99 + "title":"asics",
  100 + "url":"http://xxx/openby={"action_type":"go.product"}"
  101 + },
  102 + {
  103 + "src":"http://img10.static.yhbimg.com/xxx",
  104 + "title":"asics",
  105 + "url":"http://xxx/openby={"action_type":"go.product"}"
  106 + }
  107 + ]
  108 + }
  109 + ]
  110 +}
  111 +```
  112 +
  113 +### 2、商品列表
  114 +
  115 +#### 2.1 首页商品列表（优先级：高）
  116 +>访问地址：http://xxx.yoho.cn/xxxxxxx
  117 +
  118 +>接口示例：
  119 +
  120 +##### 请求参数
  121 +
  122 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  123 +|-------| -----|-----|-----|-----|----|
  124 +|type | string | 否 | 0 | null | type：0，推荐；1，热销；2，即将发售 |
  125 +|limt | string | 否 | 10 | null | 每页记录数 |
  126 +|page | string | 否 | 2 | null | 当前页号 |
  127 +
  128 +
  129 +##### 返回字段说明
  130 +
  131 +|参数名 |值 |描述 |
  132 +|----------------|---- |--- |
  133 +|product_skc | 123456 | 商品ID |
  134 +|product_name | LOGO鞋 | 商品名称 |
  135 +|least_price | 350 | 最低售价 |
  136 +|default_images | http://img12.static.yhbimg.com/goodsimg/xxx | 展示图片 |
  137 +|images_list | [{}] | 展示图片列表 |
  138 +|&nbsp;&nbsp; image_url | http://img10.static.yhbimg.com/xxx | 图片地址 |
  139 +|color | 白色 | 商品颜色 |
  140 +|brand_domain | Air Jordan | 品牌 |
  141 +|series | Air Jordan 4 | 系列 |
  142 +|sale_time | 2018-08-08 | 发售时间 |
  143 +|product_no | QW123456 | 货号 |
  144 +
  145 +
  146 +```json
  147 +{
  148 + "alg": "SALT_MD5",
  149 + "code": 200,
  150 + "data": {
  151 + "total": 767,
  152 + "page_total": 39,
  153 + "page": 1,
  154 + "product_list": [{
  155 + "product_skc": "123456",
  156 + "least_price": 350,
  157 + "product_name": "Carrots by Anwar X AKOP. X Champion LOGO鞋",
  158 + "default_images": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?",
  159 + "images_list": [{
  160 + "image_url": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?imageMogr2/thumbnail/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  161 + },{
  162 + "image_url": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?imageMogr2/thumbnail/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  163 + }],
  164 + "color": "白色",
  165 + "brand_domain": "Air Jordan",
  166 + "series": "Air Jordan 4",
  167 + "sale_time":"2018-08-08",
  168 + "product_no": "QW123456",
  169 + }]
  170 + }
  171 +}
  172 +```
  173 +
  174 +#### 2.2 搜索商品列表（优先级：中）
  175 +#### 2.3 搜索商品列表（优先级：中）
  176 +#### 2.4 获取筛选数据（优先级：中）
  177 +#### 2.5 品类商品列表（优先级：中）
  178 +#### 2.6 品牌商品列表（优先级：中）
  179 +#### 2.7 收藏商品列表（优先级：中）
  180 +
  181 +
  182 +<br>
  183 +
  184 +
  185 +### 3、商品详情
  186 +
  187 +#### 3.1 获取商品详情信息（优先级：高）
  188 +>访问地址：http://xxx.yoho.cn/xxxxxxx
  189 +
  190 +>接口示例：
  191 +
  192 +##### 请求参数
  193 +
  194 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  195 +|-------| -----|-----|-----|-----|----|
  196 +|product_skc | string | 否 | 12345 | null | 商品ID |
  197 +
  198 +
  199 +##### 返回字段说明
  200 +
  201 +|参数名 |值 |描述 |
  202 +|----------------|---- |--- |
  203 +|product_skc | 123456 | 商品ID |
  204 +|product_name | LOGO鞋 | 商品名称 |
  205 +|least_price | 350 | 最低售价 |
  206 +|default_images | http://img12.static.yhbimg.com/goodsimg/xxx | 展示图片 |
  207 +|images_list | [{}] | 展示图片列表 |
  208 +|&nbsp;&nbsp; image_url | http://img10.static.yhbimg.com/xxx | 图片地址 |
  209 +|color | 白色 | 商品颜色 |
  210 +|brand_domain | Air Jordan | 品牌 |
  211 +|series | Air Jordan 4 | 系列 |
  212 +|sale_time | 2018-08-08 | 发售时间 |
  213 +|product_no | QW123456 | 货号 |
  214 +
  215 +
  216 +```json
  217 +{
  218 + "alg": "SALT_MD5",
  219 + "code": 200,
  220 + "data": {
  221 + "total": 767,
  222 + "page_total": 39,
  223 + "page": 1,
  224 + "product_list": [{
  225 + "product_skc": "123456",
  226 + "least_price": 350,
  227 + "product_name": "Carrots by Anwar X AKOP. X Champion LOGO鞋",
  228 + "default_images": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?",
  229 + "images_list": [{
  230 + "image_url": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?imageMogr2/thumbnail/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  231 + },{
  232 + "image_url": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?imageMogr2/thumbnail/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  233 + }],
  234 + "color": "白色",
  235 + "brand_domain": "Air Jordan",
  236 + "series": "Air Jordan 4",
  237 + "sale_time":"2018-08-08",
  238 + "product_no": "QW123456",
  239 + }]
  240 + }
  241 +}
  242 +```
  243 +
  244 +#### 3.2 获取商品详情推荐商品（优先级：高）
  245 +
  246 +>访问地址：http://xxx.yoho.cn/xxxxxxx
  247 +
  248 +>接口示例：
  249 +
  250 +##### 请求参数
  251 +
  252 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  253 +|-------| -----|-----|-----|-----|----|
  254 +|product_skc | string | 否 | 12345 | null | 商品ID |
  255 +
  256 +
  257 +##### 返回字段说明
  258 +
  259 +|参数名 |值 |描述 |
  260 +|----------------|---- |--- |
  261 +|product_skc | 123456 | 商品ID |
  262 +|product_name | LOGO鞋 | 商品名称 |
  263 +|least_price | 350 | 最低售价 |
  264 +|default_images | http://img12.static.yhbimg.com/goodsimg/xxx | 展示图片 |
  265 +|images_list | [{}] | 展示图片列表 |
  266 +|&nbsp;&nbsp; image_url | http://img10.static.yhbimg.com/xxx | 图片地址 |
  267 +|color | 白色 | 商品颜色 |
  268 +|brand_domain | Air Jordan | 品牌 |
  269 +|series | Air Jordan 4 | 系列 |
  270 +|sale_time | 2018-08-08 | 发售时间 |
  271 +|product_no | QW123456 | 货号 |
  272 +
  273 +
  274 +```json
  275 +{
  276 + "alg": "SALT_MD5",
  277 + "code": 200,
  278 + "data": {
  279 + "total": 767,
  280 + "page_total": 39,
  281 + "page": 1,
  282 + "product_list": [{
  283 + "product_skc": "123456",
  284 + "least_price": 350,
  285 + "product_name": "Carrots by Anwar X AKOP. X Champion LOGO鞋",
  286 + "default_images": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?",
  287 + "images_list": [{
  288 + "image_url": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?imageMogr2/thumbnail/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  289 + },{
  290 + "image_url": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?imageMogr2/thumbnail/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  291 + }],
  292 + "color": "白色",
  293 + "brand_domain": "Air Jordan",
  294 + "series": "Air Jordan 4",
  295 + "sale_time":"2018-08-08",
  296 + "product_no": "QW123456",
  297 + }]
  298 + }
  299 +}
  300 +```
  301 +
  302 +#### 3.3 获取尺码信息（优先级：高）
  303 +
  304 +>访问地址：http://xxx.yoho.cn/xxxxxxx
  305 +
  306 +>接口示例：
  307 +
  308 +##### 请求参数
  309 +
  310 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  311 +|-------| -----|-----|-----|-----|----|
  312 +|product_skc | string | 否 | 12345 | null | 商品ID |
  313 +
  314 +
  315 +##### 返回字段说明
  316 +
  317 +|参数名 |值 |描述 |
  318 +|----------------|---- |--- |
  319 +|size_id | 001 | 尺码ID |
  320 +|size | 38 | 商品尺码 |
  321 +|least_price | 350 | 最低售价 |
  322 +|stock_number | 1 | 库存数量，大于0时可购买，否则不可购买 |
  323 +
  324 +
  325 +```json
  326 +{
  327 + "alg": "SALT_MD5",
  328 + "code": 200,
  329 + "data": [{
  330 + "size_id": "1001",
  331 + "size": "38",
  332 + "least_price": 350,
  333 + "stock_number": 1
  334 + }
  335 + ,{"size_id": "1002",
  336 + "size": "39",
  337 + "least_price": 999,
  338 + "stock_number": 1}
  339 + ]
  340 +}
  341 +```
  342 +