Yoho-Documents / API-Interfaces · Commits

Go to a project

Authored by DengXinFei
Commit ae0709ccbde6732f7f7fd7ae526b7e5cae1fe668 1 parent aea743bd

pc

Inline Side-by-side
Showing 1 changed file with 625 additions and 57 deletions
## 1、获取用户的验证信息 ##
## 1、获取投诉数量 ##
获取投诉数量（?method=web.complaints.getCount）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|3204031||用户id|
注意，通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway/?method=web.complaints.getCount&uid=3204031&client_type=web&client_secret=4bfdf461a964aa56d04a8927acc38363&app_version=1&v=1&os_version=1&client_secret=1&screen_size=1
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
| 参数名称 | 参数类型 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|
|count|int|20|0|投诉数量|
响应JSON格式如下所示:
```json
{
"code": 200,
"data": {
"count": 24
},
"message": "成功"
}
```
## 2、获取投诉列表 ##
获取投诉数量（?method=web.complaints.getList）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|3204031||用户id|
|page|int|否|1|1|分页页码|
|limit|int|否|10|10|分页大小|
注意，通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway/?method=web.complaints.getList&uid=3204031&page=1&limit=10&client_type=web&client_secret=20d26f1707b809bfa6e7a7a64af449c5&app_version=1&v=1&os_version=1&client_secret=1&screen_size=1
### 响应
code为200即为成功，否则是失败。
响应参数，data部分 ：
| 参数名称 | 参数类型 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|
|page|int|||当前页码|
|pageSize|int|||分页大小|
|page_total|int|||总页数|
|total|int|||总数大小|
|complaintList|list|||我的投诉对象列表【见下面】|
响应参数，complaintList部分[是个数组]：
| 参数名称 | 参数类型 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|
|complaintsType|int|1|0|投诉类型：0全部 1：产品相关 2：物流相关|
|content|string|这是投诉内容|""|投诉内容|
|createTime|string|2016-03-18 11:43:48|""|投诉时间|
|customer|string|客服A|""|投诉对象|
|id|int|18993|0|投诉id|
|orderCode|string|9508684560|""|涉及的订单号|
|pid|int|0|0|数据库的字段，没用|
|reply|string|您好，如果有问题可以咨询4008899646或者在线客服处理，感谢您对有货的支持！|""|回复内容|
|replyTime|string|2016-03-19 11:43:48|""|回复时间|
|status|int|1|1|投诉的状态 1：正常，-1：自己取消|
|title|string|这双鞋不能穿||投诉的标题|
|uid|int|3204031||投诉人的uid|
响应JSON格式如下所示:
```json
{
"code": 200,
"data": {
"complaintList": [
{
"complaintsType": 1,
"content": "content",
"createTime": "2016-03-18 11:43:48",
"customer": "customer",
"id": 18993,
"orderCode": "orderCode",
"pid": 0,
"reply": "",
"replyTime": "",
"status": 1,
"title": "title",
"uid": 3204031
},
{
"complaintsType": 1,
"content": "content",
"createTime": "2016-03-17 08:33:35",
"customer": "customer",
"id": 18987,
"orderCode": "orderCode",
"pid": 0,
"reply": "",
"replyTime": "",
"status": 1,
"title": "title",
"uid": 3204031
}
],
"page": 1,
"pageSize": 10,
"page_total": 3,
"total": 24
},
"message": "成功"
}
```
## 3、取消投诉 ##
取消投诉（?method=web.complaints.cancel）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|3204031||用户id|
|id|int|否|17||投诉id|
注意，通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway/?method=web.complaints.cancel&uid=3204031&id=17&client_type=web&client_secret=f22e55e7d9db4c575ae1f9f410a4dac8&app_version=1&v=1&os_version=1&client_secret=1&screen_size=1
### 响应
code为200即为成功，否则是失败。
响应JSON格式如下所示:
```json
{
"code": 200,
"data": [],
"message": "取消投诉成功"
}
```
## 4、新增投诉 ##
新增投诉（?method=web.complaints.add）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|3204031||用户id|
|title|string|否|你家鞋子不好||投诉标题，最长50|
|customer|string|是|客服B||投诉对象，最长30|
|complaintsType|int|否|1|0|投诉类型：0全部 1：产品相关 2：物流相关|
|orderCode|string|否|9508684560||涉及的订单号|
|content|string|否|这是投诉内容||投诉内容，最长255|
注意，通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway/?method=web.complaints.add&uid=3204031&title=title&customer=customer&complaintsType=1&orderCode=orderCode&content=content&client_type=web&client_secret=15dac0a8c9fb216cbd12d66155ec7bd5&app_version=1&v=1&os_version=1&client_secret=1&screen_size=1
### 响应
code为200即为成功，否则是失败。
响应JSON格式如下所示:
```json
{
"code": 200,
"data": [],
"message": "新增投诉成功"
}
```
## 5、PC帮助中心重构 ##
获取帮助中心列表（?method=web.help.category）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|caption|String|是|常见问题||帮助的标题|
注意，通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway/?method=web.help.category
### 响应
code为200即为成功，否则是失败。
响应JSON格式如下所示:
```json
{
"code": 200,
"data": [
{
"caption": "常见问题",
"id": 37
},
{
"caption": "警惕网络诈骗公告",
"id": 58
},
],
"message": "操作成功"
}
```
## 6、获取帮助中心内容 ##
获取帮助中心内容（?method=web.help.getHelpDetailList）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|category_id|String|否|37||帮助类别id|
|problem|String|是|送货要多长时间||问题|
|page|int|否|1|1|分页页码|
|limit|int|否|10|10|分页大小|
请求示例
http://192.168.102.205:8080/gateway/?method=web.help.getHelpDetailList&category_id=37
### 响应
code为200即为成功，否则是失败
响应JSON格式如下所示:。
响应参数，data部分
```json
{
"code": 200,
"data": {
"helpdetail_list": [
{
"answer": "您好，根据地域的不同，在您确认订购后的3-5天内我们会将货品送到。如果在您订购完成后7天内商品仍没有送达，您可以直接与YOHO！有货客服中心联系。需要说明的是：化妆品等液体商品，走的是陆运，会比普通商品晚2-3天左右，敬请谅解。如有任何疑问，请联系官网右上方的【在线客服】或致电客服热线：400-889-9646，我们将竭诚为您服务。",
"problem": "送货要多长时间？"
},
"message": "操作成功"
}
```
## 7、PC端帮助中心常见问题 ##
PC端帮助中心常见问题(?method=web.help.getCommonFaqList)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|category_id|String|否|37||帮助类别id| 以category_id为id去category查询的help_type不能是1
|problem|String|是|送货要多长时间||问题|
请求示例
http://192.168.102.205:8080/gateway/?method=web.help.getCommonFaqList&category_id=37
### 响应
code为200即为成功，否则是失败
响应JSON格式如下所示:。
响应参数，data部分
```json
{
"code": 200,
"data": {
"helpdetail_list": [
{
"answer": "您好，根据地域的不同，在您确认订购后的3-5天内我们会将货品送到。如果在您订购完成后7天内商品仍没有送达，您可以直接与YOHO！有货客服中心联系。需要说明的是：化妆品等液体商品，走的是陆运，会比普通商品晚2-3天左右，敬请谅解。如有任何疑问，请联系官网右上方的【在线客服】或致电客服热线：400-889-9646，我们将竭诚为您服务。",
"problem": "送货要多长时间？"
},
"message": "操作成功"
}
```
## 8、兑换礼品卡 ##
兑换礼品卡(?method=web.personCen.giftExchange)
请求示例
http://127.0.0.1:8080/gateway/?method=web.personCen.giftExchange&uid=5687179&giftCardCode1=123&giftCardCode2=456&giftCardCode3=789&captchaCode=1234
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
giftCardCode1|String|否|兑换码1|4597
giftCardCode2|String|否|兑换码2|1365
giftCardCode3|String|否|兑换码3|7546
captchaCode|String|否|验证码|k754
uid|String|否|用户id|457
### 响应
code为200即为成功，否则是失败
响应JSON格式如下所示:
```json
{
"code": 200,
"message": "礼品卡充值成功.",
"data": {
"denomination": 10000
},
"md5": "4129cb45c9e7001ff5b90d0e221a6d29"
}
```
## 9 获取用户信息 ##
获取用户信息（?method=open.passport.get）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|5357305||用户id|
注意，通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway/?method=open.passport.get&uid=5357305
### 响应
code为200即为成功，否则是失败。
响应JSON格式如下所示:（与PHP返回一致）
```json
{
"code": 200,
"data": {
"data": {
"YohocoinCount": 0, //有货币数量
"couponCount": 0, //优惠券数量
"head_ico": "", //头像
"messageCount": 0, //未读消息数
"orderCount": 10, //待处理订单数
"profile_name": "18****59670", //名称
"random": 1458380115.093,
"refundCount": 0, //退换货数量
"token": "",
"uid": 5357305, //用户id
"vip": { //VIP信息
"curTotalCost": "0.0",
"curVipInfo": {
"commonDiscount": "1.0",
"curLevel": "0",
"needCost": "0.0",
"nextLevel": "1",
"premiumScops": [],
"promotionDiscount": "1.0",
"title": "普通会员"
},
"curYearCost": "0.0",
"curYearCostPer": "0",
"fitTime": "1451053087",
"nextVipInfo": {
"commonDiscount": "0.95",
"curLevel": "1",
"needCost": "600.0",
"nextLevel": "2",
"premiumScops": ["1", "4","10","8","9"],
"promotionDiscount": "0.95",
"title": "银卡会员"
},
"upgradeNeedCost": "600.0", //升级需要消费的数量
"upgradeNeedCostPer": "100", //升级需要消费的比例
"vipEndDay": "295",
"vipEndTime": "1483885087",
"vipRemainDays": "295",
"vipStartTime": "1452349087"
}
},
"result": "1"
},
"message": "User info"
}
```
## 10、PC重构--我的咨询 ##
我的咨询（？method=web.personCen.buyConsult）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|string|否|12|0|用户id|
|page|int|否|1|1|分页页码|
|limit|int|否|10|10|分页大小|
注意，通用的头部没有列出。
请求示例
http://127.0.0.1:8080/gateway/?method=web.personCen.buyConsult&uid=12
### 响应
code为200即为成功，否则是失败。
响应JSON格式如下所示:
```json
{
"code": 200,
"data": {
"consult_list": [
{
"answer": "您好，这款衣服只有这一个颜色了，感谢您的关注。",
"answerTime": 1309530731,
"answerUserId": 1,
"ask": "",
"askTime": 1308711168,
"askUserId": 12,
"brandId": 63,
"id": 4,
"maxSortId": 2,
"middleSortId": 19,
"productId": 943,
"productName": "K*facto.2y梭织肌理印花短袖西装",
"skn": 50000116,
"smallSortId": 122
}
],
"page": 1,
"page_total": 1,
"total": 1
},
"message": "my consult list"
}
```
## 11、批量设置消息为已读 ##
批量设置消息为已读（method=web.inbox.setread）
#### 请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|ids|string||否|1,2,3||需要设置为已读的消息的id，以逗号分隔|
|uid|string||否|123456|0|用户id|
注意，通用的头部没有列出。
请求示例
http://127.0.0.1:8080/gateway?method=web.inbox.setread&uid=5088713&ids=9,10,11
### 响应
用户响应JSON格式如下所示:
```json
{
"code": 200,
"data": {
"code": 200,
"message": "success."
},
"message": "操作成功"
}
```
code为200即为成功，否则是失败。
## 12、获取用户的验证信息 ##
获取用户的验证信息（method=web.passport.getUserVerifyInfo）
#### 请求参数
... ... @@ -40,7 +488,10 @@ code为200即为成功，否则是失败。
}
```
## 2、验证密码是否正确 ##
----------
## 13、验证密码是否正确 ##
验证密码是否正确（method=web.passport.verifyUserPwd）
#### 请求参数
... ... @@ -70,7 +521,7 @@ code为200即为成功，否则是失败。
----------
## 3、修改当前账号密码 ##
## 14、修改当前账号密码 ##
修改当前账号密码（method=web.passport.changePwd）
#### 请求参数
... ... @@ -100,7 +551,7 @@ code为200即为成功，否则是失败。
----------
## 4、发送短信验证码到手机 ##
## 15、发送短信验证码到手机 ##
发送短信验证码到手机（method=web.passport.sendcode）
#### 请求参数
... ... @@ -127,7 +578,7 @@ code为200即为成功，否则是失败。
----------
## 5、验证短信验证码是否正确 ##
## 16、验证短信验证码是否正确 ##
验证短信验证码是否正确（method=web.passport.checkcode）
#### 请求参数
... ... @@ -156,7 +607,7 @@ code为200即为成功，否则是失败。
----------
## 6、修改验证手机前的检查 ##
## 17、修改验证手机前的检查 ##
修改验证的手机前的检查（method=web.passport.checkVerifyMobile）
#### 请求参数
... ... @@ -164,10 +615,11 @@ code为200即为成功，否则是失败。
|:-------| -----:|-----:|-----:|-----:|----:|
|mobile|string|否|13912345678||手机号码|
|area|string|否|86||国家码|
|uid|int|否|||用户id|
注意，通用的头部没有列出。
请求示例
http://127.0.0.1:8080/gateway?method=web.passport.checkVerifyMobile&area=86&mobile=13912345678
http://127.0.0.1:8080/gateway?method=web.passport.checkVerifyMobile&area=86&mobile=13912345678&uid=111
### 响应
code为200即为成功，否则是失败。
... ... @@ -184,7 +636,7 @@ code为200即为成功，否则是失败。
----------
## 7、修改验证的手机 ##
## 18、修改验证的手机 ##
修改验证的手机（method=web.passport.changeVerifyMobile）
调用该方法前，必须先要调用web.passport.checkVerifyMobile该接口做检查
... ... @@ -217,7 +669,7 @@ code为200即为成功，否则是失败。
----------
## 7、验证邮箱，发送邮件 ##
## 19、验证邮箱，发送邮件 ##
验证邮箱，发送邮件（method=web.passport.verifyEmail）
#### 请求参数
... ... @@ -244,7 +696,7 @@ code为200即为成功，否则是失败。
----------
## 8、找回密码，判断code是否有效 ##
## 20、找回密码，判断code是否有效 ##
找回密码，判断code是否有效（method=web.passport.checkCodeValid）
#### 请求参数
... ... @@ -270,7 +722,7 @@ code为200即为成功，否则是失败。
----------
## 10、修改验证的邮箱 ##
## 21、修改验证的邮箱 ##
修改验证的邮箱（method=web.passport.changeEmail）
#### 请求参数
... ... @@ -294,72 +746,188 @@ code为200即为成功，否则是失败。
}
```
## 11、获取个人信息##
获取文章作者信息（?method=open.passport.get）
----------
## 22、查询我的有货币列表 ##
查询我的有货币列表（method=app.yohocoin.lists）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|5357305|0|用户id|
|uid|int|否|123||用户id|
|limit|int|是|10|10|查询多少条|
|page|int|是|1|1|第几页（从第一页开始）|
|queryType|int|是|1|0|查询类型（0-所有；1-收入；2-支出）|
|beginTime|string|是|2015-12-12||查询开始时间（格式：yyyy-MM-dd）|
|endTime|string|是|2015-12-22||查询结束时间（格式：yyyy-MM-dd）|
注意，通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway/?method=open.passport.get&uid=5357305&debug=XYZ
http://127.0.0.1:8081/gateway?method=app.yohocoin.lists&uid=123&queryType=1
### 响应
code为200即为成功，否则是失败。
响应JSON格式如下所示:（是按PHP代码返回的）
用户响应JSON格式如下所示:
```json
{
"code": 200,
"data": {
"data": {
"YohocoinCount": 0,//有货币数量
"couponCount": 0,//优惠券数量
"head_ico": "",//头像
"messageCount": 0,//未读消息数
"orderCount": 10,//待处理订单数
"profile_name": "18****59670",//名称
"random": 1458378392.046,//以前接口返回的，不知道啥用
"refundCount": 0,//退换货数量
"token": "",//以前的字段，现在没有
"uid": 5357305,//用户id
"vip": { //用户vip信息
"curTotalCost": "0.0",//总消费
"curVipInfo": { //当前vip信息
"commonDiscount": "1.0", //普通折扣
"curLevel": "0", //当前等级
"needCost": "0.0",//需要花费多少
"nextLevel": "1",//下一等级
"premiumScops": [],//VIP权限
"promotionDiscount": "1.0",//促销折扣
"title": "普通会员"//VIP名称
"coinlist": [
{
"date": "2015-12-30 20:18:59",
"message": "充值",
"num": 1
},
"curYearCost": "0.0", //当年消费多少
"curYearCostPer": "0",//目前消费百分比
"fitTime": "1451053087",//以前的逻辑，是vipStartTime-15天
"nextVipInfo": {//下一等级VIP信息
"commonDiscount": "0.95",
"curLevel": "1",
"needCost": "600.0",
"nextLevel": "2",
"premiumScops": ["1","4","10","8","9"],
"promotionDiscount": "0.95",
"title": "银卡会员"
{
"date": "2015-12-30 19:19:34",
"message": "晒单奖励：",
"num": 1
},
"upgradeNeedCost": "600.0",//升级需要花费多少
"upgradeNeedCostPer": "100",//升级需要的百分比
"vipEndDay": "295",//VIP剩余多少天
"vipEndTime": "1483885087",//VIP结束时间
"vipRemainDays": "295",//VIP剩余多少天
"vipStartTime": "1452349087"//VIP开始时间
}
....
],
"limit": 20,
"page": 1,
"page_total": 11,
"total": 11
},
"result": "1"
"message": "yoho coin list"
}
```
----------
## 23、查询我的红包列表 ##
查询我的红包列表（method=app.yoho.redpacketList）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|123||用户id|
注意，通用的头部没有列出。
请求示例
http://127.0.0.1:8081/gateway?method=app.yoho.redpacketList&uid=123
### 响应
code为200即为成功，否则是失败。
用户响应JSON格式如下所示:
```json
{
"code": 200,
"data": [
{
"amount": 0.68,
"endTime": "",
"id": 851414,
"remark": "加红包",
"startTime": ""
},
"message": "User info"
{
"amount": 2.48,
"endTime": "",
"id": 851415,
"remark": "加红包",
"startTime": ""
},
.....
],
"message": "操作成功"
}
```
----------
## 24、查询我的vip信息 ##
查询我的VIP信息（method=app.passport.vip）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|123||用户id|
|client_type|String|否|web||客户端类型（web,h5,android,ipad,iphone）|
注意，通用的头部没有列出。
请求示例
http://127.0.0.1:8081/gateway?method=app.passport.vip&uid=123&client_type=iphone
### 响应
code为200即为成功，否则是失败。
用户响应JSON格式如下所示:
```json
{
"code": 200,
"data": {
"current_total_cost": "0.00",
"current_vip_level": "0",
"current_vip_title": "普通会员",
"current_year_cost": "0.00",
"enjoy_preferential": [],
"next_need_cost": 600,
"next_vip_level": "1",
"next_vip_title": "银卡会员",
"upgrade_need_cost": "600.0",
"vip_end_time": "1461136668",
"vip_reach_time": "1428304668",
"vip_start_time": "1429600668"
},
"message": "vip."
}
```
----------
## 25、发送验证邮件到邮箱 ##
发送验证邮件到邮箱（method=web.passport.sendVerifyEmailInfo）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|email|string|否|abcdef||待发送邮件的邮箱|
|callback|string|否|abcdef||邮件中，点击的连接地址|
注意，通用的头部没有列出。
请求示例
http://127.0.0.1:8081/gateway?method=web.passport.sendVerifyEmailInfo&email=abcdef&callback=xxxxxxxx
### 响应
code为200即为成功，否则是失败。
用户响应JSON格式如下所示:
```json
{
"code": 200,
"data": [],
"message": "操作成功"
}
```
----------
## 26、检查该邮箱是否可以验证 ##
检查该邮箱是否可以验证（method=web.passport.checkVerifyEmail）
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|email|string|否|abcdef||待验证的邮箱|
|uid|string|否|abcdef||用户id|
注意，通用的头部没有列出。
请求示例
http://127.0.0.1:8081/gateway?method=web.passport.checkVerifyEmail&email=abcdef&uid=123
### 响应
code为200即为成功，否则是失败。
用户响应JSON格式如下所示:
```json
{
"code": 200,
"data": [],
"message": "操作成功"
}
```
\ No newline at end of file
... ...