戴晖 / API-Interfaces · Commits

Go to a project

Authored by bblu
Commit ad37ef0a10ebf990a666b42c1594d5846ac4cb04 1 parent e4b1d3b0

会员日接口文档

Inline Side-by-side
Showing 5 changed files with 269 additions and 0 deletions
## 1、会员日签到##
会员日签到（/activity/UserdaySigninController/signin）
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
|app_version|float|10|否|1||APP版本|
|os_version|string|20|否|Android4.4||系统版本+机器型号|
|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
|screen_size|string|20|否|800x900||（手机尺寸）|
#### 请求参数
| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|int|1-11|否|12356||用户uid|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|/activity/UserdaySigninController/signin|
|接口说明|会员日签到|
|http请求方式|POST/GET|
#### 返回错误
|错误code|错误提示|
|:-------| -----:|
|500|参数不合法|
注意，通用的头部没有列出。
请求示例
/activity/UserdaySigninController/signin?uid=12356
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": {},
"md5": "6d729d4b35f10fc73531210bd7ecff91",
"message": "发送成功."
}
```
响应失败JSON格式如下所示:
```json
{
"message":"参数不合法",
"code":500
}
```
... ...
## 1、保存用户留言##
保存用户留言（/activity/UserdayLeaveWordsController/addLeaveWords）
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
|app_version|float|10|否|1||APP版本|
|os_version|string|20|否|Android4.4||系统版本+机器型号|
|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
|screen_size|string|20|否|800x900||（手机尺寸）|
#### 请求参数
| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|int|1-11|否|12356||用户uid|
|nick_name|String|1-30|否|jack||用户昵称|
|content|String|1-1000|否|如果能有NMD限购款在会员日专享，那就太好了||用户留言|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|/activity/UserdayLeaveWordsController/addLeaveWords|
|接口说明|保存用户留言|
|http请求方式|POST/GET|
#### 返回错误
|错误code|错误提示|
|:-------| -----:|
|500|参数不合法|
注意，通用的头部没有列出。
请求示例
/activity/UserdayLeaveWordsController/addLeaveWords?uid=12356&nick_name=jack&content=如果能有NMD限购款在会员日专享，那就太好了
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": 1, // 1-表示获得一次疯狂大转盘抽奖机会，0-没有疯狂大转盘抽奖机会
"md5": "6d729d4b35f10fc73531210bd7ecff91",
"message": "发送成功."
}
```
响应失败JSON格式如下所示:
```json
{
"message":"参数不合法",
"code":500
}
```
... ...
## 1、拼手气大转盘抽奖##
拼手气大转盘抽奖（/activity/UserdayPrizeLogController/addPrizeLog）
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
|app_version|float|10|否|1||APP版本|
|os_version|string|20|否|Android4.4||系统版本+机器型号|
|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
|screen_size|string|20|否|800x900||（手机尺寸）|
#### 请求参数
| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|int|1-11|否|12356||用户uid|
|prize_type|int|1-11|否|1||抽奖类型：1-拼手气，2-疯狂大转盘|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|/activity/UserdayPrizeLogController/addPrizeLog|
|接口说明|拼手气大转盘抽奖|
|http请求方式|POST/GET|
#### 返回错误
|错误code|错误提示|
|:-------| -----:|
|500|参数不合法|
注意，通用的头部没有列出。
请求示例
/activity/UserdayPrizeLogController/addPrizeLog?uid=12356&prize_type=1
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": 10, // prize_type为1时即拼手机中奖有货币数量，0表示未中奖；prize_type为2时即大转盘中奖优惠券面值；
"md5": "6d729d4b35f10fc73531210bd7ecff91",
"message": "发送成功."
}
```
响应失败JSON格式如下所示:
```json
{
"message":"参数不合法",
"code":500
}
```
... ...
## 1、拼手气大转盘是否中奖##
拼手气大转盘是否中奖（/activity/UserdayPrizeLogController/existsPrizeLog）
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
|app_version|float|10|否|1||APP版本|
|os_version|string|20|否|Android4.4||系统版本+机器型号|
|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
|screen_size|string|20|否|800x900||（手机尺寸）|
#### 请求参数
| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|int|1-11|否|12356||用户uid|
|prize_type|int|1-11|否|1||抽奖类型：1-拼手气，2-疯狂大转盘|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|/activity/UserdayPrizeLogController/existsPrizeLog|
|接口说明|拼手气大转盘是否中奖|
|http请求方式|POST/GET|
#### 返回错误
|错误code|错误提示|
|:-------| -----:|
|500|参数不合法|
注意，通用的头部没有列出。
请求示例
/activity/UserdayPrizeLogController/existsPrizeLog?uid=12356&prize_type=1
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": true, // true-中奖，false-未中奖
"md5": "6d729d4b35f10fc73531210bd7ecff91",
"message": "发送成功."
}
```
响应失败JSON格式如下所示:
```json
{
"message":"参数不合法",
"code":500
}
```
... ...
## 1、查询用户留言##
查询用户留言（/activity/UserdayLeaveWordsController/queryLeaveWordsList）
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
|app_version|float|10|否|1||APP版本|
|os_version|string|20|否|Android4.4||系统版本+机器型号|
|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
|screen_size|string|20|否|800x900||（手机尺寸）|
#### 请求参数
| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|int|1-11|否|12356||用户uid|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|/activity/UserdayLeaveWordsController/queryLeaveWordsList|
|接口说明|查询用户留言|
|http请求方式|POST/GET|
#### 返回错误
|错误code|错误提示|
|:-------| -----:|
|500|参数不合法|
注意，通用的头部没有列出。
请求示例
/activity/UserdayLeaveWordsController/queryLeaveWordsList?uid=12356
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": [
"我希望有货币可以兑换有货的神券",
"想参加每年一次的吴亦凡生日会活动",
"讲真，我开始期待下个月的会员日了",
"在会员日get到关注已久的潮牌，还有专属价，开心的不要不要的！"
],
"md5": "6d729d4b35f10fc73531210bd7ecff91",
"message": "发送成功."
}
```
响应失败JSON格式如下所示:
```json
{
"message":"参数不合法",
"code":500
}
```
... ...