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
UFO 接口
\ No newline at end of file
## 业务模块
#### 1、首页
#####     1.1、首页资源位接口（优先级：高）
#### 2、商品列表
#####     2.1 首页商品列表（优先级：高）
######     2.2 搜索商品列表（优先级：中）
######     2.3 搜索商品列表（优先级：中）
######     2.4 获取筛选数据（优先级：中）
######     2.5 品类商品列表（优先级：中）
######     2.6 品牌商品列表（优先级：中）
######     2.7 收藏商品列表（优先级：中）
#### 3、商品详情页
#####     3.1、获取商品详情信息（优先级：高）
#####     3.2、获取商品详情推荐商品（优先级：高）
#####     3.3、获取尺码信息（优先级：高）
#### 4、卖家出售商品
#####     4.1 实名认证（优先级：高）
#####     4.2 获取出售商品信息（优先级：高）
#####     4.3 地址管理（优先级：高）
#####     4.4 地址新增（优先级：高）
#####     4.5 地址编辑（优先级：中）
#####     4.6 地址删除（优先级：中）
#####     4.7 支付保证金（优先级：高）
#### 5、品类、品牌
######     5.1 品类资源位（优先级：中）
######     5.2 品牌墙列表（优先级：中）
#### 6、消息
######     6.1 消息数字（优先级：低）
######     6.2 消息列表（优先级：中）
#### 7、我的
######     7.1 购买、出售、收藏数字（优先级：低）
#### 8、出售订单
#####     8.1 出售订单列表（优先级：高）
######     8.2 出售订单详情（优先级：中）
######     8.3 不卖了（操作）（优先级：中）
######     8.4 支付保证金（操作）（优先级：中）
#### 9、购买订单
<br>
## 接口参数说明
### 1、首页
#### 1.1 首页资源位接口（优先级：高）
>访问地址：http://xxx.yoho.cn/xxxxxxx
>接口示例：
##### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|-------| -----|-----|-----|-----|----|
|content_code | string | 否 | xxxxxx | null | 资源位码 |
##### 返回字段说明
|参数名 |值 |描述 |
|----------------|---- |--- |
|template_id | 12345 | 资源位楼层id |
|template_name | focus | 楼层类型，focus：轮播图；hotSeries：热门系列 |
|list | [{}] | 楼层数据 |
|&nbsp;&nbsp; src | http://img10.static.yhbimg.com/xxx | 图片地址 |
|&nbsp;&nbsp; title | asics | 标题 |
|&nbsp;&nbsp; url | http://xxx/openby={"action_type":"go.product"} | 跳转url |
##### 响应JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": [
{
"template_id":123456,
"template_name":"focus",
"list":[
{
"src":"http://img10.static.yhbimg.com/xxx",
"title":"asics",
"url":"http://xxx/openby={"action_type":"go.product"}"
},
{
"src":"http://img10.static.yhbimg.com/xxx",
"title":"asics",
"url":"http://xxx/openby={"action_type":"go.product"}"
}
]
},
{
"template_id":123456,
"template_name":"hotSeries",
"list":[
{
"src":"http://img10.static.yhbimg.com/xxx",
"title":"asics",
"url":"http://xxx/openby={"action_type":"go.product"}"
},
{
"src":"http://img10.static.yhbimg.com/xxx",
"title":"asics",
"url":"http://xxx/openby={"action_type":"go.product"}"
}
]
}
]
}
```
### 2、商品列表
#### 2.1 首页商品列表（优先级：高）
>访问地址：http://xxx.yoho.cn/xxxxxxx
>接口示例：
##### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|-------| -----|-----|-----|-----|----|
|type | string | 否 | 0 | null | type：0，推荐；1，热销；2，即将发售 |
|limt | string | 否 | 10 | null | 每页记录数 |
|page | string | 否 | 2 | null | 当前页号 |
##### 返回字段说明
|参数名 |值 |描述 |
|----------------|---- |--- |
|product_skc | 123456 | 商品ID |
|product_name | LOGO鞋 | 商品名称 |
|least_price | 350 | 最低售价 |
|default_images | http://img12.static.yhbimg.com/goodsimg/xxx | 展示图片 |
|images_list | [{}] | 展示图片列表 |
|&nbsp;&nbsp; image_url | http://img10.static.yhbimg.com/xxx | 图片地址 |
|color | 白色 | 商品颜色 |
|brand_domain | Air Jordan | 品牌 |
|series | Air Jordan 4 | 系列 |
|sale_time | 2018-08-08 | 发售时间 |
|product_no | QW123456 | 货号 |
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": {
"total": 767,
"page_total": 39,
"page": 1,
"product_list": [{
"product_skc": "123456",
"least_price": 350,
"product_name": "Carrots by Anwar X AKOP. X Champion LOGO鞋",
"default_images": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?",
"images_list": [{
"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",
},{
"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",
}],
"color": "白色",
"brand_domain": "Air Jordan",
"series": "Air Jordan 4",
"sale_time":"2018-08-08",
"product_no": "QW123456",
}]
}
}
```
#### 2.2 搜索商品列表（优先级：中）
#### 2.3 搜索商品列表（优先级：中）
#### 2.4 获取筛选数据（优先级：中）
#### 2.5 品类商品列表（优先级：中）
#### 2.6 品牌商品列表（优先级：中）
#### 2.7 收藏商品列表（优先级：中）
<br>
### 3、商品详情
#### 3.1 获取商品详情信息（优先级：高）
>访问地址：http://xxx.yoho.cn/xxxxxxx
>接口示例：
##### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|-------| -----|-----|-----|-----|----|
|product_skc | string | 否 | 12345 | null | 商品ID |
##### 返回字段说明
|参数名 |值 |描述 |
|----------------|---- |--- |
|product_skc | 123456 | 商品ID |
|product_name | LOGO鞋 | 商品名称 |
|least_price | 350 | 最低售价 |
|default_images | http://img12.static.yhbimg.com/goodsimg/xxx | 展示图片 |
|images_list | [{}] | 展示图片列表 |
|&nbsp;&nbsp; image_url | http://img10.static.yhbimg.com/xxx | 图片地址 |
|color | 白色 | 商品颜色 |
|brand_domain | Air Jordan | 品牌 |
|series | Air Jordan 4 | 系列 |
|sale_time | 2018-08-08 | 发售时间 |
|product_no | QW123456 | 货号 |
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": {
"total": 767,
"page_total": 39,
"page": 1,
"product_list": [{
"product_skc": "123456",
"least_price": 350,
"product_name": "Carrots by Anwar X AKOP. X Champion LOGO鞋",
"default_images": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?",
"images_list": [{
"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",
},{
"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",
}],
"color": "白色",
"brand_domain": "Air Jordan",
"series": "Air Jordan 4",
"sale_time":"2018-08-08",
"product_no": "QW123456",
}]
}
}
```
#### 3.2 获取商品详情推荐商品（优先级：高）
>访问地址：http://xxx.yoho.cn/xxxxxxx
>接口示例：
##### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|-------| -----|-----|-----|-----|----|
|product_skc | string | 否 | 12345 | null | 商品ID |
##### 返回字段说明
|参数名 |值 |描述 |
|----------------|---- |--- |
|product_skc | 123456 | 商品ID |
|product_name | LOGO鞋 | 商品名称 |
|least_price | 350 | 最低售价 |
|default_images | http://img12.static.yhbimg.com/goodsimg/xxx | 展示图片 |
|images_list | [{}] | 展示图片列表 |
|&nbsp;&nbsp; image_url | http://img10.static.yhbimg.com/xxx | 图片地址 |
|color | 白色 | 商品颜色 |
|brand_domain | Air Jordan | 品牌 |
|series | Air Jordan 4 | 系列 |
|sale_time | 2018-08-08 | 发售时间 |
|product_no | QW123456 | 货号 |
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": {
"total": 767,
"page_total": 39,
"page": 1,
"product_list": [{
"product_skc": "123456",
"least_price": 350,
"product_name": "Carrots by Anwar X AKOP. X Champion LOGO鞋",
"default_images": "http://img12.static.yhbimg.com/goodsimg/2018/07/08/11/020c790e2f22a3eaf063e4fc1751b4d8f1.jpg?",
"images_list": [{
"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",
},{
"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",
}],
"color": "白色",
"brand_domain": "Air Jordan",
"series": "Air Jordan 4",
"sale_time":"2018-08-08",
"product_no": "QW123456",
}]
}
}
```
#### 3.3 获取尺码信息（优先级：高）
>访问地址：http://xxx.yoho.cn/xxxxxxx
>接口示例：
##### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|-------| -----|-----|-----|-----|----|
|product_skc | string | 否 | 12345 | null | 商品ID |
##### 返回字段说明
|参数名 |值 |描述 |
|----------------|---- |--- |
|size_id | 001 | 尺码ID |
|size | 38 | 商品尺码 |
|least_price | 350 | 最低售价 |
|stock_number | 1 | 库存数量，大于0时可购买，否则不可购买 |
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": [{
"size_id": "1001",
"size": "38",
"least_price": 350,
"stock_number": 1
}
,{"size_id": "1002",
"size": "39",
"least_price": 999,
"stock_number": 1}
]
}
```
... ...