tanling / API-Interfaces · Commits

Go to a project

Authored by LUOXC
Commit 6a3ca4e60b8ed20b952f4f3f3ca7109bf5324fa5 2 parents f94eacb6 f9eaf378

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

# Conflicts:
#	订单/保存预支付信息接口.md
Inline Side-by-side
Showing 4 changed files with 190 additions and 18 deletions
@@ -211,11 +211,11 @@ code为200即为成功，否则是失败。 @@ -211,11 +211,11 @@ code为200即为成功，否则是失败。
211 #### 请求参数 211 #### 请求参数
212 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 212 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
213 |:-------| -----:|-----:|-----:|-----:|----:| 213 |:-------| -----:|-----:|-----:|-----:|----:|
214 -|shop|string|是|649|null|店铺id| 214 +|shop_id|string|是|649|null|店铺id|
215 215
216 注意，通用的头部没有列出，其他条件同原来保持一致。 216 注意，通用的头部没有列出，其他条件同原来保持一致。
217 请求示例 217 请求示例
218 -http://devapi.yoho.cn:58078/gateway/?limit=20&method=app.search.li&order=s_n_desc&page=1&productSize=240x319&shop=649&v=7&yh_channel=&query=MACROPUS&debug=XYZ 218 +http://devapi.yoho.cn:58078/gateway/?limit=20&method=app.search.li&order=s_n_desc&page=1&productSize=240x319&shop_id=649&v=7&yh_channel=&query=MACROPUS&debug=XYZ
219 ### 响应 219 ### 响应
220 code为200即为成功，否则是失败。 220 code为200即为成功，否则是失败。
221 响应JSON格式如下所示: 221 响应JSON格式如下所示:
@@ -598,7 +598,7 @@ code为200即为成功，否则是失败。 @@ -598,7 +598,7 @@ code为200即为成功，否则是失败。
598 #### 请求参数 598 #### 请求参数
599 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 599 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
600 |:-------| -----:|-----:|-----:|-----:|----:| 600 |:-------| -----:|-----:|-----:|-----:|----:|
601 -|shops_id|int|否|356|无|店铺id| 601 +|shop_id|int|否|356|无|店铺id|
602 |yh_channel|string|是|1|无|频道| 602 |yh_channel|string|是|1|无|频道|
603 |gender|string|是|1|无|性别| 603 |gender|string|是|1|无|性别|
604 604
@@ -761,11 +761,11 @@ code为200即为成功，否则是失败。 @@ -761,11 +761,11 @@ code为200即为成功，否则是失败。
761 #### 请求参数 761 #### 请求参数
762 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 762 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
763 |:-------| -----:|-----:|-----:|-----:|----:| 763 |:-------| -----:|-----:|-----:|-----:|----:|
764 -|shop|string|是|649|null|店铺id| 764 +|shop_id|string|是|649|null|店铺id|
765 765
766 注意，通用的头部没有列出，其他条件同原来保持一致。 766 注意，通用的头部没有列出，其他条件同原来保持一致。
767 请求示例 767 请求示例
768 -http://devapi.yoho.cn:58078/gateway/?limit=20&method=app.search.li&order=s_n_desc&page=1&productSize=240x319&shop=649&v=7&yh_channel=&query=MACROPUS&debug=XYZ 768 +http://devapi.yoho.cn:58078/gateway/?limit=20&method=app.search.li&order=s_n_desc&page=1&productSize=240x319&shop_id=649&v=7&yh_channel=&query=MACROPUS&debug=XYZ
769 ### 响应 769 ### 响应
770 code为200即为成功，否则是失败。 770 code为200即为成功，否则是失败。
771 响应JSON格式如下所示: 771 响应JSON格式如下所示:
@@ -1150,7 +1150,7 @@ code为200即为成功，否则是失败。 @@ -1150,7 +1150,7 @@ code为200即为成功，否则是失败。
1150 |:-------| -----:|-----:|-----:|-----:|----:| 1150 |:-------| -----:|-----:|-----:|-----:|----:|
1151 |yh_channel|string|是|1|null|频道id| 1151 |yh_channel|string|是|1|null|频道id|
1152 |brand|string|是|649|null|品牌id| 1152 |brand|string|是|649|null|品牌id|
1153 -|shop|string|是|649|null|店铺id| 1153 +|shop_id|string|是|649|null|店铺id|
1154 |order|string|是|s_n_desc|null|排序规则| 1154 |order|string|是|s_n_desc|null|排序规则|
1155 |limit|int|是|20|20|每页数据大小| 1155 |limit|int|是|20|20|每页数据大小|
1156 |page|int|是|1|1|当前页| 1156 |page|int|是|1|1|当前页|
@@ -1695,7 +1695,7 @@ code为200即为成功，否则是失败。 @@ -1695,7 +1695,7 @@ code为200即为成功，否则是失败。
1695 |categoryId|string|否|5|无|二级分类id| 1695 |categoryId|string|否|5|无|二级分类id|
1696 |subCategoryId|string|是|45|无|三级分类id| 1696 |subCategoryId|string|是|45|无|三级分类id|
1697 |sort|string|否|114,293|无|三级子分类id| 1697 |sort|string|否|114,293|无|三级子分类id|
1698 -|shop|string|否|635|无|店铺id| 1698 +|shop_id|string|否|635|无|店铺id|
1699 1699
1700 注意，通用的头部没有列出，同原来分类商品列表接口。 1700 注意，通用的头部没有列出，同原来分类商品列表接口。
1701 请求示例 1701 请求示例
@@ -2610,4 +2610,147 @@ code为200即为成功，否则是失败。 @@ -2610,4 +2610,147 @@ code为200即为成功，否则是失败。
2610 "md5": "3294e4beb6a3c83349a3879e81d3c2ac", 2610 "md5": "3294e4beb6a3c83349a3879e81d3c2ac",
2611 "message": "Category Product List." 2611 "message": "Category Product List."
2612 } 2612 }
  2613 +```
  2614 +## 14、yoho所有品牌列表接口##
  2615 +
  2616 +（method=app.brand.brandlist）
  2617 +#### 请求参数
  2618 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  2619 +|:-------| -----:|-----:|-----:|-----:|----:|
  2620 +|yh_channel|string|是|1|无|频道id|
  2621 +
  2622 +品牌店铺需求，需要在品牌列表的每个品牌上增加用于跳转的枚举值type：
  2623 +无店铺：0--->品牌页
  2624 +无单品店有多品店：1--->搜索页
  2625 +有单品店：2--->店铺页面
  2626 +请求示例
  2627 +http://127.0.0.1:8080/gateway/?method=app.brand.brandlist&v=7&yh_channel=1&debug=XYZ
  2628 +
  2629 +### 响应
  2630 +code为200即为成功，否则是失败。
  2631 +响应JSON格式如下所示:
  2632 +```json
  2633 +{
  2634 + "alg": "SALT_MD5",
  2635 + "code": 200,
  2636 + "data": {
  2637 + "brands": {
  2638 + "": [
  2639 + {
  2640 + "brand_alif": "",
  2641 + "brand_domain": "dirtlun",
  2642 + "brand_ico": "http://img13.static.yhbimg.com/brandLogo/2016/03/23/13/02bcd71ac660607888bd58af8d21b8a0c1.jpg?imageMogr2/thumbnail/{width}x{height}/extent/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  2643 + "brand_keyword": "",
  2644 + "brand_name": "第二轮",
  2645 + "brand_name_cn": "",
  2646 + "brand_name_en": "第二轮",
  2647 + "hot_keyword": "",
  2648 + "id": "1559",
  2649 + "is_hot": "2",
  2650 + "is_show_new": "N",
  2651 + "shop_id": 647,
  2652 + "type": "2"
  2653 + },
  2654 + {
  2655 + "brand_alif": "",
  2656 + "brand_domain": "rtytry",
  2657 + "brand_ico": "http://img10.static.yhbimg.com/brandLogo/2016/03/18/14/010e6e67e28597232f89fb4ddb34babf28.jpg?imageMogr2/thumbnail/{width}x{height}/extent/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  2658 + "brand_keyword": "",
  2659 + "brand_name": "请不要用我的品牌，谢谢",
  2660 + "brand_name_cn": "",
  2661 + "brand_name_en": "ytiuyi",
  2662 + "hot_keyword": "",
  2663 + "id": 1555,
  2664 + "is_hot": "N",
  2665 + "is_show_new": "N",
  2666 + "type": "1"
  2667 + }
  2668 + ],
  2669 + "0~9": [
  2670 + {
  2671 + "brand_alif": "5",
  2672 + "brand_domain": "5preview",
  2673 + "brand_ico": "http://img13.static.yhbimg.com/brandLogo/2015/11/17/16/02202c3d541b9b0b67aaf32068b32f4884.jpg?imageMogr2/thumbnail/{width}x{height}/extent/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  2674 + "brand_keyword": "趣味,休闲",
  2675 + "brand_name": "5 PREVIEW",
  2676 + "brand_name_cn": "",
  2677 + "brand_name_en": "5 PREVIEW",
  2678 + "hot_keyword": "",
  2679 + "id": 526,
  2680 + "is_hot": "N",
  2681 + "is_show_new": "N",
  2682 + "type": "0"
  2683 + }
  2684 + ]
  2685 + }
  2686 + },
  2687 + "message": "success"
  2688 +}
  2689 +```
  2690 +## 15、根据品牌id查询店铺列表接口##
  2691 +
  2692 +（method=app.shop.queryShopsByBrandId）
  2693 +#### 请求参数
  2694 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  2695 +|:-------| -----:|-----:|-----:|-----:|----:|
  2696 +|brand_id|int|否|526|无|品牌id|
  2697 +
  2698 +http://127.0.0.1:8080/gateway/?method=app.shop.queryShopsByBrandId&v=7&brand_id=526&debug=XYZ
  2699 +
  2700 +### 响应
  2701 +code为200即为成功，否则是失败。
  2702 +响应JSON格式如下所示:
  2703 +```json
  2704 +{
  2705 + "alg": "SALT_MD5",
  2706 + "code": 200,
  2707 + "data": [
  2708 + {
  2709 + "brand_domain": "http://img13.static.yhbimg.com/brandLogo/2015/11/17/16/02202c3d541b9b0b67aaf32068b32f4884.jpg?imageMogr2/thumbnail/{width}x{height}/extent/{width}x{height}/background/d2hpdGU=/position/center/quality/80",
  2710 + "brand_id": 526,
  2711 + "brand_name": "5 PREVIEW"
  2712 + }
  2713 + ],
  2714 + "md5": "a69d83093e3d3ebc864a06e6da2ee17f",
  2715 + "message": "product brandshop Intro"
  2716 +}
  2717 +
  2718 +{
  2719 + "alg": "SALT_MD5",
  2720 + "code": 200,
  2721 + "data": [
  2722 + {
  2723 + "brand_domain": "",
  2724 + "brand_id": 1559,
  2725 + "brand_name": "新增店铺1222",
  2726 + "shop_id": 636
  2727 + },
  2728 + {
  2729 + "brand_domain": "/2016/03/29/20/0160698e7d0b06a2ed21cfbae3c50a32eb.jpg",
  2730 + "brand_id": 1559,
  2731 + "brand_name": "33333",
  2732 + "shop_id": 641
  2733 + },
  2734 + {
  2735 + "brand_domain": "",
  2736 + "brand_id": 1559,
  2737 + "brand_name": "了极乐空间立刻见拉开距离靠捡垃圾立刻见拉开距离靠捡垃圾立刻见李经理李经理建立建立极乐空间看见了据了解立刻见",
  2738 + "shop_id": 647
  2739 + },
  2740 + {
  2741 + "brand_domain": "/2016/04/08/16/0130ff219200cb6dcfc25b9a2c572133c3.jpg",
  2742 + "brand_id": 1559,
  2743 + "brand_name": "拉通测试店铺A勿动，谢谢！",
  2744 + "shop_id": 670
  2745 + },
  2746 + {
  2747 + "brand_domain": "/2016/04/09/14/013d7e1b2519d3f8c1ecbdd4e929fbf456.jpg",
  2748 + "brand_id": 1559,
  2749 + "brand_name": "周六加班测店铺",
  2750 + "shop_id": 672
  2751 + }
  2752 + ],
  2753 + "md5": "d4fb7018f27973c1f00ebaae579c02c7",
  2754 + "message": "product brandshop Intro"
  2755 +}
2613 ``` 2756 ```
@@ -4,17 +4,16 @@ @@ -4,17 +4,16 @@
4 #### 请求参数 4 #### 请求参数
5 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 5 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
6 |:-------| -----:|-----:|-----:|-----:|----:| 6 |:-------| -----:|-----:|-----:|-----:|----:|
7 -|uid|int|否|205455||用户id|  
8 -|product_skn|String|否|12556||skn|  
9 -|product_sku|String|否|25665||sku|  
10 -|product_skc|String|否|15566||skc|  
11 -|color_name|String|否|蓝色||颜色| 7 +|uid|String|否|3566164||用户id|
  8 +|product_skn|String|否|50001796||skn|
  9 +|product_sku|String|否|102034||sku|
  10 +|product_skc|String|否|14||skc|
  11 +|color_name|String|否|黑||颜色|
12 |size_name|String|否|L||尺码| 12 |size_name|String|否|L||尺码|
13 13
14 注意，通用的头部没有列出。 14 注意，通用的头部没有列出。
15 请求示例 15 请求示例
16 -http://192.168.102.205:8080/gateway?method=app.limitProduct.userChoiceSku&uid=12342&productSkn=56665&productSku=222&colorName=蓝色&sizeName=L&productSkc=15556  
17 - 16 +http://192.168.102.205:8080/gateway?method=app.limitProduct.userChoiceSku&uid=3566164&product_skn=50001796&product_sku=102034&product_skc=14&size_name=L&color_name=黑
18 ### 响应 17 ### 响应
19 code为200即为成功，否则是失败。 18 code为200即为成功，否则是失败。
20 响应参数，data部分 19 响应参数，data部分
@@ -44,11 +43,11 @@ code为200即为成功，否则是失败。 @@ -44,11 +43,11 @@ code为200即为成功，否则是失败。
44 #### 请求参数 43 #### 请求参数
45 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 | 44 | 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
46 |:-------| -----:|-----:|-----:|-----:|----:| 45 |:-------| -----:|-----:|-----:|-----:|----:|
47 -|skn|String|否|205455||用户id| 46 +|product_skn|String|否|50001796||用户id|
48 47
49 注意，通用的头部没有列出。 48 注意，通用的头部没有列出。
50 请求示例 49 请求示例
51 -http://192.168.102.205:8080/activity?method=app.limitProduct.getGoodListBySkus&skn=12342 50 +http://192.168.102.205:8080/gateway?method=app.limitProduct.getLimitProductDataBySkn&debug=XYZ&product_skn=50001796
52 51
53 ### 响应 52 ### 响应
54 code为200即为成功，否则是失败。 53 code为200即为成功，否则是失败。
@@ -176,7 +175,7 @@ code为200即为成功，否则是失败。 @@ -176,7 +175,7 @@ code为200即为成功，否则是失败。
176 |limit|Integer|1-3|是|||分页大小| 175 |limit|Integer|1-3|是|||分页大小|
177 176
178 注意，通用的头部没有列出。 177 注意，通用的头部没有列出。
179 -请求示例http://127.0.0.1:8090/activity/?method=app.drawline.addQueue&limitProductCode=3&app_version=4.0.1&uid=109&activityId=11 178 +请求示例http://127.0.0.1:8090/activity/?method=app.drawline.addQueue&app_version=4.0.1&uid=109&activityId=11
180 179
181 ### 响应 180 ### 响应
182 code为200即为成功，否则是失败。 181 code为200即为成功，否则是失败。
  1 +# 购物车服务接口
  2 +
  3 +### 购物车查询
  4 +
  5 +
  6 +### 接口说明
  7 +
  8 +| 接口说明 | 接口说明 |
  9 +| :-- | -----: |
  10 +| 接口名 | app.Shopping.cart |
  11 +| 接口说明 | 查询购物车 |
  12 +| http请求方式 | GET/POST |
  13 +
  14 +### 请求参数
  15 +| 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 |
  16 +| :-- | :-- | :-- | :-- | :-- | :-- |
  17 +| method | string | 是 | app.Shopping.cart | | |
  18 +| uid | int | 否 | 5772257 | | |
  19 +| shopping_key | string | 否 | c36408a268e9b9418189d9a71967379e | | |
  20 +| sale_channel | string | 否 | 1 | 1 | |
  21 +
  22 +### 正常返回结果
  23 +```json
  24 +{
  25 +
  26 +}
  27 +```
@@ -46,9 +46,12 @@ @@ -46,9 +46,12 @@
46 | 25 | 银联在线支付 | 46 | 25 | 银联在线支付 |
47 | 26 | QQ钱包手机支付 | 47 | 26 | QQ钱包手机支付 |
48 | 40 | QQ支付 | 48 | 40 | QQ支付 |
  49 +
  50 +> 备注：app 支付宝支付 发送15 （包括支付宝手机和支付宝wap）
  51 +
49 ### 请求示例 52 ### 请求示例
50 http://192.168.102.205:8080/gateway?method=app.order.savePrePayInfo&uid=8041834&orderCode=111111111&payment=1&debug=XYZ 53 http://192.168.102.205:8080/gateway?method=app.order.savePrePayInfo&uid=8041834&orderCode=111111111&payment=1&debug=XYZ
51 -### 正常返回结果 54 +#### 正常返回结果
52 ```json 55 ```json
53 { 56 {
54 "alg": "SALT_MD5", 57 "alg": "SALT_MD5",