jack / API-Interfaces · Commits

Go to a project

Authored by zhouxiang
Commit da4f1ddaf95dad32fef69253aad8cdfc78304609 2 parents ba724391 05059bca

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

Inline Side-by-side
Showing 3 changed files with 224 additions and 2 deletions
@@ -96,4 +96,219 @@ code为200即为成功，否则是失败。 @@ -96,4 +96,219 @@ code为200即为成功，否则是失败。
96 "md5": "bc08c52373b36a0578293aa334176879", 96 "md5": "bc08c52373b36a0578293aa334176879",
97 "message": "success!" 97 "message": "success!"
98 } 98 }
  99 +```
  100 +
  101 +## 3、邀请好友赢福利之后领取优惠券 ##
  102 +邀请好友赢福利之后领取优惠券(?method=wap.invite.receiveCoupons）
  103 +
  104 +#### 请求参数
  105 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  106 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  107 +|uid|int|否|50001796|0|用户id|
  108 +|activityId|int|否|22|0|活动id|
  109 +|nums|int|否|2|0|发送优惠券的数量|
  110 +|shareUid|int|否|50001711|0|分享者的uid|
  111 +|openId|String|否|adb124||微信的union_id|
  112 +
  113 +
  114 +### 请求示例
  115 +http://api.yoho.cn?method=wap.invite.receiveCoupons&uid=50001796&activityId=22&nums=2&shareUid=50001711&openId=adb124
  116 +
  117 +### 响应
  118 +code为200即为成功，否则是失败。
  119 + - 300-很抱歉！参数错误
  120 + - 500-活动不存在
  121 + - 400-活动状态不正确
  122 + - 401-没有分享记录
  123 + -304:很抱歉！优惠券信息不存在
  124 +
  125 +响应参数，data部分
  126 +
  127 +
  128 +| 参数名称 | 参数类型 | 示例 | 备注 |
  129 +|:-------| -----:|-----:|-----:|----:|
  130 +|url|String|/appactive/invite/shareover|跳转的url|
  131 +
  132 +响应成功JSON格式如下所示:
  133 +```json
  134 +{
  135 + "alg": "SALT_MD5",
  136 + "code": 200,
  137 + "data": [{
  138 + "url" : /appactive/invite/shareover,
  139 + }],
  140 + "md5": "bc08c52373b36a0578293aa334176879",
  141 + "message": "success!"
  142 +}
  143 +```
  144 +
  145 +
  146 +## 4、微信好友获取红包方法(即分享出去的地址) ##
  147 +微信好友获取红包方法(即分享出去的地址)(?method=wap.invite.share）
  148 +
  149 +#### 请求参数
  150 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  151 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  152 +|uid|int|否|50001796|0|用户id|
  153 +|activityId|int|否|22|0|活动id|
  154 +|nums|int|否|2|0|发送优惠券的数量|
  155 +|openId|String|否|adb124||微信的union_id|
  156 +|nickName|String|否|-|0|微信昵称|
  157 +|headImgUrl|String|否|-|0|微信头像|
  158 +
  159 +
  160 +### 请求示例
  161 +http://api.yoho.cn?method=wap.invite.share&uid=50001796&activityId=22&nums=2&openId=adb124&nickName=清凉&headImgUrl=
  162 +
  163 +### 响应
  164 +code为200即为成功，否则是失败。
  165 + - 300-很抱歉！参数错误
  166 + - 401-没有分享记录
  167 +
  168 +响应参数，data部分
  169 +
  170 +
  171 +| 参数名称 | 参数类型 | 示例 | 备注 |
  172 +|:-------| -----:|-----:|-----:|----:|
  173 +|shareUrl|String|-|跳转的url|
  174 +|activityBo|Object|-|活动信息|
  175 +|list|Array|-|分享记录列表|
  176 +|shareUid|int|-|分享着uid|
  177 +|nums|int|-|数量|
  178 +|activityId|int|-|活动id|
  179 +
  180 +响应成功JSON格式如下所示:
  181 +```json
  182 +{
  183 + "alg": "SALT_MD5",
  184 + "code": 200,
  185 + "data": [{
  186 + "shareUrl" : "...."
  187 + }],
  188 + "md5": "bc08c52373b36a0578293aa334176879",
  189 + "message": "success!"
  190 +}
  191 +```
  192 +
  193 +
  194 +## 5、好友领取完优惠券的页面 ##
  195 +好友领取完优惠券的页面(?method=wap.invite.myCoupons）
  196 +
  197 +#### 请求参数
  198 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  199 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  200 +|uid|int|否|50001796|0|用户uid|
  201 +|shareUid|int|否|22|0|分享着uid|
  202 +|nums|int|否|2|0|发送优惠券的数量|
  203 +|amount|String|否|4||金额|
  204 +|activityId|String|否|-|0|活动id|
  205 +
  206 +
  207 +### 请求示例
  208 +http://api.yoho.cn?method=wap.invite.myCoupons&uid=50001796&shareUid=121254&nums=3&amount=4&activityId=22
  209 +
  210 +### 响应
  211 +code为200即为成功，否则是失败。
  212 + - 300-很抱歉！参数错误
  213 +
  214 +响应参数，data部分
  215 +
  216 +
  217 +| 参数名称 | 参数类型 | 示例 | 备注 |
  218 +|:-------| -----:|-----:|-----:|----:|
  219 +|myProfile|Object|-|用户profile信息|
  220 +|list|Array|-|分享记录列表|
  221 +|amount|int|-|金额|
  222 +
  223 +响应成功JSON格式如下所示:
  224 +```json
  225 +{
  226 + "alg": "SALT_MD5",
  227 + "code": 200,
  228 + "data": {
  229 + "myProfile" : {"uid":1111,"email":"aabbc@dd.com","mobile":"15464652135"},
  230 + "list":[{}],
  231 + "amount":4
  232 + },
  233 + "md5": "bc08c52373b36a0578293aa334176879",
  234 + "message": "success!"
  235 +}
  236 +```
  237 +
  238 +
  239 +## 6、根据第三方id，查询绑定信息 ##
  240 +根据第三方id，查询绑定信息（?method=wap.invite.getBindLogByOpenId）
  241 +
  242 +#### 请求参数
  243 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  244 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  245 +|openIds|string|否|a,b,c|0|第三方id，用逗号隔开|
  246 +
  247 +
  248 +### 请求示例
  249 +http://api.yoho.cn?method=wap.invite.getBindLogByOpenId&openIds=a,b,c
  250 +
  251 +### 响应
  252 +code为200即为成功，否则是失败。
  253 +
  254 +
  255 +响应参数，data部分
  256 +
  257 +
  258 +| 参数名称 | 参数类型 | 示例 | 备注 |
  259 +|:-------| -----:|-----:|-----:|----:|
  260 +|id|int|123|主键id|
  261 +|uid|int|123|用户uid|
  262 +|openId|string|adfadsf|第三方id|
  263 +|snsNick|string|adfadsf|昵称|
  264 +|snsHeadimg|string|adfadsf|头像|
  265 +|bindTime|int|1234566|绑定时间（时间戳：秒）|
  266 +|snsType|int|1|第三方平台类型 1微信 2微博|
  267 +
  268 +
  269 +响应成功JSON格式如下所示:
  270 +```json
  271 +{
  272 + "alg": "SALT_MD5",
  273 + "code": 200,
  274 + "data": [{
  275 + "id" : 1,
  276 + "uid" : 2,
  277 + "openId" : "adfasdf",
  278 + "snsNick" : "adsfasdf",
  279 + "snsHeadimg" : "http:///",
  280 + "bindTime" : 1352435234,
  281 + "snsType" : 1
  282 + }],
  283 + "md5": "bc08c52373b36a0578293aa334176879",
  284 + "message": "success!"
  285 +}
  286 +```
  287 +
  288 +
  289 +## 7、注册 ##
  290 +注册（?method=wap.invite.register）
  291 +
  292 +#### 请求参数
  293 +| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
  294 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  295 +|mobile|string|否|12356984542||手机号|
  296 +|activityName|string|否|||活动名称|
  297 +
  298 +
  299 +### 请求示例
  300 +http://api.yoho.cn?method=wap.invite.register&mobile=12584569325&activityName=邀请好友赢福利
  301 +
  302 +### 响应
  303 +code为200即为成功，否则是失败。
  304 +
  305 +响应成功JSON格式如下所示:
  306 +```json
  307 +{
  308 + "alg": "SALT_MD5",
  309 + "code": 200,
  310 + "data": {},
  311 + "md5": "bc08c52373b36a0578293aa334176879",
  312 + "message": "success!"
  313 +}
99 ``` 314 ```
@@ -30,7 +30,7 @@ @@ -30,7 +30,7 @@
30 30
31 注意，通用的头部没有列出。 31 注意，通用的头部没有列出。
32 请求示例 32 请求示例
33 -http://192.168.102.205:8095/social/?method=app.social.getPostsInfo&postsId=80 33 +http://192.168.102.205:8095/social/?method=app.social.getPostsInfo&postsId=600
34 34
35 ### 响应 35 ### 响应
36 code为200即为成功，否则是失败。 36 code为200即为成功，否则是失败。
@@ -100,6 +100,12 @@ code为200即为成功，否则是失败。 @@ -100,6 +100,12 @@ code为200即为成功，否则是失败。
100 } 100 }
101 } 101 }
102 ], 102 ],
  103 + "shareGoods": {
  104 + "productName": "GAWS FOOT 黑白拼色金属装饰感运动鞋",
  105 + "productUrl": "http://m.yohobuy.com/product/pro_274533_354613/GAWSFOOTYunDongXieGAFA504SN26BKW.html",
  106 + "salesPrice": "399",
  107 + "goodsImage": "http://img13.static.yhbimg.com/goodsimg/2015/10/13/07/02f540054acfd5920e3e3bd475704ea9eb.jpg?imageMogr2/thumbnail/{width}x{height}/extent/{width}x{height}/background/d2hpdGU=/position/center/quality/80"
  108 + }
103 "publishTime": "2016-06-29 14:04:54", 109 "publishTime": "2016-06-29 14:04:54",
104 "publishTimeString": "3小时前", 110 "publishTimeString": "3小时前",
105 "revieweState": 0, 111 "revieweState": 0,
@@ -8,7 +8,8 @@ @@ -8,7 +8,8 @@
8 | 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 | 8 | 名称 | 类型 | 是否必须 | 示例值 | 默认值 | 描述 |
9 | :-- | :-- | :-- | :-- | :-- | :-- | 9 | :-- | :-- | :-- | :-- | :-- | :-- |
10 | method | String | 是 | app.SpaceOrders.updateDeliveryAddress| |请求方法| 10 | method | String | 是 | app.SpaceOrders.updateDeliveryAddress| |请求方法|
11 -| order_code | String | 是 | "1607472719" ||订单号 | 11 +| order_code | long | 是 | 1607472719 ||订单号 |
  12 +| uid | int | 是 | 8050080 ||用户ID |
12 | address_id | String | 否 | "944005" ||地址ID（仅用于app）| 13 | address_id | String | 否 | "944005" ||地址ID（仅用于app）|
13 | user_name | String | 否 | "刘子阳" ||收货人（仅用于PC）| 14 | user_name | String | 否 | "刘子阳" ||收货人（仅用于PC）|
14 | area_code | String | 否 | "10101" ||地区编号（仅用于PC）| 15 | area_code | String | 否 | "10101" ||地区编号（仅用于PC）|