quintin.zhang / yohobuy-doc · Commits

Go to a project

Authored by ping
Commit baafb1422d63b0c28f273aa6a989397444584936 1 parent 2fc3008e

update

Inline Side-by-side
Showing 1 changed file with 149 additions and 176 deletions
1 -# 活动模板接口服务定义  
2 ----------------------- 1 +支付中心管理接口定义
3 2
4 -# 查询模板列表接口 3 +**1、获取支付管理列表**
5 4
6 -> 接口名：`activityTemplatelectTemplateList` 5 + 获取支付管理列表（/PayManageController/findPayManageList）
7 6
8 -### 入参 7 +**请求参数**
9 8
10 -----------------------------------  
11 -|属性名称|类型|例子|说明|是否必填|  
12 -|--------|----|----|----|--------|  
13 -|status|integer|1|状态：0 不启用 ，1 启用 |否|  
14 ----------------------------------- 9 +无
15 10
16 -### 返回 11 +**请求示例**
17 12
18 -``` json  
19 -{  
20 - "code":200,  
21 - "message":"请求成功",  
22 - "data": [  
23 - {  
24 - "createTime": 1453966206,  
25 - "id": 1,  
26 - "image": "", // 图片链接  
27 - "shareId": 0,  
28 - "status": 1, // 0 不启用 ，1 启用  
29 - "title": "",  
30 - "url": ""  
31 - }  
32 - ]  
33 -}  
34 -```  
35 -  
36 -# 添加模板接口 13 +注意，通用的头部没有列出
37 14
38 -> 接口名：`activityTemplate/addTemplate` 15 +http://localhost:8080/platform/PayManageController/findPayManageList
39 16
40 -### 入参  
41 17
42 -----------------------------------  
43 -|属性名称|类型|例子|说明|是否必填|  
44 -|--------|----|----|----|--------|  
45 -|title|string|新人专享活动模板|模板标题|是|  
46 -|image|string|http://yoho.cn/18282.jpg|图片地址|否|  
47 -|url|string|http://yoho.cn/18282.template|模板地址|否|  
48 -|shareId|integer|1|共享ID|否|  
49 ----------------------------------- 18 +**响应**
50 19
51 -### 返回 20 +code为200即为成功，否则是失败。 响应JSON格式如下所示:
52 21
53 -``` json  
54 -{  
55 - "code":200,  
56 - "message":"添加成功！"  
57 -}  
58 -``` 22 + {
  23 + "code": 200,
  24 + "data":{
  25 + "currentPage":1
  26 + "rows":[{"id": 2,
  27 + "payName": "支付宝",
  28 + "recommendOrderPage":1,
  29 + "recommendWords":"",
  30 + "sortNumber":2,
  31 + "recommendText1":"",
  32 + "recommendText2":"",
  33 + "status":1,
  34 + "createTime":"";
  35 + "updateTime":""},{
  36 + "id": 3,
  37 + "payName": "微信",
  38 + "recommendOrderPage":1,
  39 + "recommendWords":"",
  40 + "sortNumber":1,
  41 + "recommendText1":"",
  42 + "recommendText2":"",
  43 + "status":1,
  44 + "createTime":"";
  45 + "updateTime":""}],
  46 + "pageSize":10,
  47 + "total":10,
  48 + "totalPage":1
  49 + },
  50 + "md5": "d751713988987e9331980363e24189ce",
  51 + "message": "操作成功"
  52 + }
59 53
60 -# 更新模板接口  
61 54
62 -> 接口名：`activityTemplate/updateTeplate` 55 +**2、获取支付方式详情**
63 56
64 -### 入参 57 +获取支付方式详情(/PayManageController/findPayInfoById)
65 58
66 -----------------------------------  
67 -|属性名称|类型|例子|说明|是否必填|  
68 -|--------|----|----|----|--------|  
69 -|id|integer|1|主键|是|  
70 -|title|string|新人专享活动模板|模板标题|是|  
71 -|image|string|http://yoho.cn/18282.jpg|图片地址|否|  
72 -|url|string|http://yoho.cn/18282.template|模板地址|否|  
73 -|shareId|integer|1|共享ID|否|  
74 ----------------------------------- 59 +**请求参数**
75 60
76 -### 返回 61 +| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
  62 +| ---------|:--------:| --------:|-----:|------:|-----:|
  63 +|id |int | 否 |1 | | |
77 64
78 -``` json  
79 -{  
80 - "code":200,  
81 - "message":"添加成功！"  
82 -}  
83 -```  
84 65
85 -# 开启模板接口 66 +**请求示例**
86 67
87 -> 接口名：`activityTemplate/publishTemplate` 68 +注意，通用的头部没有列出
88 69
89 -### 入参 70 +http://localhost:8080/platform/PayManageController/findPayInfoById
90 71
91 -----------------------------------  
92 -|属性名称|类型|例子|说明|是否必填|  
93 -|--------|----|----|----|--------|  
94 -|id|integer|1|主键|是|  
95 ----------------------------------- 72 + {
  73 + "id":2
  74 + }
96 75
97 -### 返回  
98 76
99 -``` json  
100 -{  
101 - "code":200,  
102 - "message":"操作成功！"  
103 -}  
104 -``` 77 +**响应**
105 78
106 -# 关闭模板接口 79 + {
  80 + "code": 200,
  81 + "data": {
  82 + "id": 2,
  83 + "payName": "支付宝",
  84 + "recommendOrderPage":1,
  85 + "recommendWords":"",
  86 + "sortNumber":2,
  87 + "recommendText1":"",
  88 + "recommendText2":"",
  89 + "status":1,
  90 + "createTime":"";
  91 + "updateTime":""
  92 + },
  93 + "md5": "d751713988987e9331980363e24189ce",
  94 + "message": "操作成功"
  95 + }
107 96
108 -> 接口名：`activityTemplate/closeTemplate` 97 +**3、新增支付方式**
109 98
110 -### 入参 99 +新增支付方式（/PayManageController/createPayMode）
111 100
112 -----------------------------------  
113 -|属性名称|类型|例子|说明|是否必填|  
114 -|--------|----|----|----|--------|  
115 -|id|integer|1|主键|是|  
116 ----------------------------------- 101 +**请求参数**
117 102
118 -### 返回 103 +| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
  104 +| ---------|:--------:| --------:|-----:|------:|-----:|
  105 +|payName |String | 否 |支付宝 | | 支付方式名称 |
  106 +|recommendOrderPage |int | 否 |0 | 0 |是否推荐到确认订单页,0-否；1-是|
  107 +|recommendWords |String | 是 | | | 推荐文案 |
  108 +|sortNumber |int | 否 |1 | 0 | 前端排序值，数字越大越靠前 |
  109 +|recommendText1 |String | 是 | | |推荐语1 |
  110 +|recommendText2 |String | 是 | | | 推荐语2 |
119 111
120 -``` json  
121 -{  
122 - "code":200,  
123 - "message":"操作成功！"  
124 -}  
125 -```  
126 112
127 -# 根据条件查询活动商品列表接口 113 +**请求示例**
128 114
129 -> 接口名：`activityTemplate/getProductListByCondition` 115 +注意，通用的头部没有列出
130 116
131 -### 入参 117 +http://localhost:8080/platform/PayManageController/createPayMode
132 118
133 -----------------------------------  
134 -|属性名称|类型|例子|说明|是否必填|  
135 -|--------|----|----|----|--------|  
136 -|templateId|integer|1|模板ID|是|  
137 -|productSkn|integer|1|商品SKN|否|  
138 ----------------------------------- 119 + {
  120 + "payName":"支付宝",
  121 + "recommendOrderPage":1,
  122 + "recommendWords":"推荐文案",
  123 + "sortNumber":2,
  124 + "recommendText1":""
  125 + }
139 126
140 -### 返回 127 +**响应**
141 128
142 -``` json  
143 -{  
144 - "code": 200,  
145 - "data": {  
146 - "list": [  
147 { 129 {
148 - "id": 1,  
149 - "isRecommend": true,  
150 - "orderBy": 110,  
151 - "productSkn": 51125277,  
152 - "status": 1,  
153 - "templateId": 2 130 + "code": 200,
  131 + "data": {},
  132 + "md5": "d751713988987e9331980363e24189ce",
  133 + "message": "操作成功"
154 } 134 }
155 - ],  
156 - "page": 1,  
157 - "size": 10,  
158 - "total": 1,  
159 - "totalPage": 1  
160 - },  
161 - "message": "Temp SKN list"  
162 -}  
163 -```  
164 135
165 -# 插入活动商品信息接口  
166 136
167 -> 接口名：`activityTemplate/insertProduct` 137 +**4、编辑支付方式详情**
168 138
169 -### 入参 139 +编辑支付方式(/PayManageController/updatePayInfoById)
170 140
171 -----------------------------------  
172 -|属性名称|类型|例子|说明|是否必填|  
173 -|--------|----|----|----|--------|  
174 -|templateId|integer|1|模板ID|是|  
175 -|productSkn|integer|1|商品SKN|是|  
176 ----------------------------------- 141 +**请求参数**
177 142
178 -### 返回 143 +| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
  144 +| ---------|:--------:| --------:|-----:|------:|-----:|
  145 +|id |int | 否 |1 | | |
  146 +|payName |String | 否 |支付宝 | | 支付方式名称，不可修改 |
  147 +|recommendOrderPage |int | 否 |0 | 0 |是否推荐到确认订单页,0-否；1-是|
  148 +|recommendWords |String | 是 | | | 推荐文案 |
  149 +|sortNumber |int | 否 |1 | 0 | 前端排序值，数字越大越靠前 |
  150 +|recommendText1 |String | 是 | | |推荐语1 |
  151 +|recommendText2 |String | 是 | | | 推荐语2 |
179 152
180 -``` json  
181 -{  
182 - "code": 200,  
183 - "message": "添加成功",  
184 -}  
185 -```  
186 153
  154 +**请求示例**
187 155
188 -# 更新商品信息接口 156 +注意，通用的头部没有列出
189 157
190 -> 接口名：`activityTemplate/updateProduct` 158 +http://localhost:8080/platform/PayManageController/updatePayInfoById
191 159
192 -### 入参  
193 -  
194 -----------------------------------  
195 -|属性名称|类型|例子|说明|是否必填|  
196 -|--------|----|----|----|--------|  
197 -|id|integer|1|商品ID|是|  
198 -|orderBy|integer|1|排序号|否|  
199 -|isRecommend|integer|1|是否推荐|否|  
200 -|status|integer|1|是否启用|否|  
201 ----------------------------------- 160 + {
  161 + "id":2,
  162 + "recommendOrderPage":1,
  163 + "recommendWords":"推荐文案",
  164 + "sortNumber":2
  165 + }
202 166
203 -### 返回 167 +**响应**
204 168
205 -``` json  
206 -{ 169 + {
207 "code": 200, 170 "code": 200,
208 - "message": "操作成功",  
209 -}  
210 -``` 171 + "data": {},
  172 + "md5": "d751713988987e9331980363e24189ce",
  173 + "message": "操作成功"
  174 + }
  175 +
211 176
212 -# 删除商品信息接口 177 +**5、关闭/开启支付方式**
213 178
214 -> 接口名：`activityTemplate/delOneProduct` 179 +关闭/开启支付方式(/PayManageController/offOrOnPayModeById)
215 180
216 -### 入参 181 + **请求参数**
217 182
218 -----------------------------------  
219 -|属性名称|类型|例子|说明|是否必填|  
220 -|--------|----|----|----|--------|  
221 -|id|integer|1|主键|是|  
222 ----------------------------------- 183 +| 参数名称 | 参数类型 |可否为空 |示例 |默认值 | 备注 |
  184 +| ---------|:--------:| --------:|-----:|------:|-----:|
  185 +|id |int | 否 |1 | | |
  186 +|status |int | 否 |1 | | 0-关闭，1-开启 |
223 187
224 -### 返回 188 +**请求示例**
225 189
226 -如果删除失败，可能是没有删除权限。 190 +注意，通用的头部没有列出
227 191
228 -``` json  
229 -{  
230 - "code":200,  
231 - "message":"操作成功！"  
232 -}  
233 -```  
  192 +http://localhost:8080/platform/PayManageController/offOrOnPayModeById
  193 +
  194 + {
  195 + "id":2,
  196 + "status":1
  197 + }
  198 +
  199 +**响应**
  200 +
  201 + {
  202 + "code": 200,
  203 + "data": {},
  204 + "md5": "d751713988987e9331980363e24189ce",
  205 + "message": "操作成功"
  206 + }