Yoho-Documents / 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 +## 1、会员日签到##
  2 +
  3 +会员日签到（/activity/UserdaySigninController/signin）
  4 +#### 公共请求参数
  5 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  7 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  8 +|app_version|float|10|否|1||APP版本|
  9 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  10 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  11 +|screen_size|string|20|否|800x900||（手机尺寸）|
  12 +
  13 +#### 请求参数
  14 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  15 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  16 +|uid|int|1-11|否|12356||用户uid|
  17 +
  18 +#### 接口说明
  19 +| 接口说明||
  20 +|:-------| -----:|
  21 +|请求域名|http://api.yoho.cn|
  22 +|接口名|/activity/UserdaySigninController/signin|
  23 +|接口说明|会员日签到|
  24 +|http请求方式|POST/GET|
  25 +#### 返回错误
  26 +|错误code|错误提示|
  27 +|:-------| -----:|
  28 +|500|参数不合法|
  29 +注意，通用的头部没有列出。
  30 +请求示例
  31 +/activity/UserdaySigninController/signin?uid=12356
  32 +
  33 +### 响应
  34 +code为200即为成功，否则是失败。
  35 +响应参数，data部分
  36 +响应成功JSON格式如下所示:
  37 +```json
  38 +{
  39 + "alg": "SALT_MD5",
  40 + "code": 200,
  41 + "data": {},
  42 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  43 + "message": "发送成功."
  44 +}
  45 +```
  46 +响应失败JSON格式如下所示:
  47 +```json
  48 +{
  49 + "message":"参数不合法",
  50 + "code":500
  51 + }
  52 +```
  1 +## 1、保存用户留言##
  2 +
  3 +保存用户留言（/activity/UserdayLeaveWordsController/addLeaveWords）
  4 +#### 公共请求参数
  5 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  7 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  8 +|app_version|float|10|否|1||APP版本|
  9 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  10 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  11 +|screen_size|string|20|否|800x900||（手机尺寸）|
  12 +
  13 +#### 请求参数
  14 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  15 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  16 +|uid|int|1-11|否|12356||用户uid|
  17 +|nick_name|String|1-30|否|jack||用户昵称|
  18 +|content|String|1-1000|否|如果能有NMD限购款在会员日专享，那就太好了||用户留言|
  19 +
  20 +#### 接口说明
  21 +| 接口说明||
  22 +|:-------| -----:|
  23 +|请求域名|http://api.yoho.cn|
  24 +|接口名|/activity/UserdayLeaveWordsController/addLeaveWords|
  25 +|接口说明|保存用户留言|
  26 +|http请求方式|POST/GET|
  27 +#### 返回错误
  28 +|错误code|错误提示|
  29 +|:-------| -----:|
  30 +|500|参数不合法|
  31 +注意，通用的头部没有列出。
  32 +请求示例
  33 +/activity/UserdayLeaveWordsController/addLeaveWords?uid=12356&nick_name=jack&content=如果能有NMD限购款在会员日专享，那就太好了
  34 +
  35 +### 响应
  36 +code为200即为成功，否则是失败。
  37 +响应参数，data部分
  38 +响应成功JSON格式如下所示:
  39 +```json
  40 +{
  41 + "alg": "SALT_MD5",
  42 + "code": 200,
  43 + "data": 1, // 1-表示获得一次疯狂大转盘抽奖机会，0-没有疯狂大转盘抽奖机会
  44 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  45 + "message": "发送成功."
  46 +}
  47 +```
  48 +响应失败JSON格式如下所示:
  49 +```json
  50 +{
  51 + "message":"参数不合法",
  52 + "code":500
  53 + }
  54 +```
  1 +## 1、拼手气大转盘抽奖##
  2 +
  3 +拼手气大转盘抽奖（/activity/UserdayPrizeLogController/addPrizeLog）
  4 +#### 公共请求参数
  5 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  7 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  8 +|app_version|float|10|否|1||APP版本|
  9 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  10 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  11 +|screen_size|string|20|否|800x900||（手机尺寸）|
  12 +
  13 +#### 请求参数
  14 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  15 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  16 +|uid|int|1-11|否|12356||用户uid|
  17 +|prize_type|int|1-11|否|1||抽奖类型：1-拼手气，2-疯狂大转盘|
  18 +
  19 +#### 接口说明
  20 +| 接口说明||
  21 +|:-------| -----:|
  22 +|请求域名|http://api.yoho.cn|
  23 +|接口名|/activity/UserdayPrizeLogController/addPrizeLog|
  24 +|接口说明|拼手气大转盘抽奖|
  25 +|http请求方式|POST/GET|
  26 +#### 返回错误
  27 +|错误code|错误提示|
  28 +|:-------| -----:|
  29 +|500|参数不合法|
  30 +注意，通用的头部没有列出。
  31 +请求示例
  32 +/activity/UserdayPrizeLogController/addPrizeLog?uid=12356&prize_type=1
  33 +
  34 +### 响应
  35 +code为200即为成功，否则是失败。
  36 +响应参数，data部分
  37 +响应成功JSON格式如下所示:
  38 +```json
  39 +{
  40 + "alg": "SALT_MD5",
  41 + "code": 200,
  42 + "data": 10, // prize_type为1时即拼手机中奖有货币数量，0表示未中奖；prize_type为2时即大转盘中奖优惠券面值；
  43 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  44 + "message": "发送成功."
  45 +}
  46 +```
  47 +响应失败JSON格式如下所示:
  48 +```json
  49 +{
  50 + "message":"参数不合法",
  51 + "code":500
  52 + }
  53 +```
  1 +## 1、拼手气大转盘是否中奖##
  2 +
  3 +拼手气大转盘是否中奖（/activity/UserdayPrizeLogController/existsPrizeLog）
  4 +#### 公共请求参数
  5 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  7 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  8 +|app_version|float|10|否|1||APP版本|
  9 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  10 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  11 +|screen_size|string|20|否|800x900||（手机尺寸）|
  12 +
  13 +#### 请求参数
  14 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  15 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  16 +|uid|int|1-11|否|12356||用户uid|
  17 +|prize_type|int|1-11|否|1||抽奖类型：1-拼手气，2-疯狂大转盘|
  18 +
  19 +#### 接口说明
  20 +| 接口说明||
  21 +|:-------| -----:|
  22 +|请求域名|http://api.yoho.cn|
  23 +|接口名|/activity/UserdayPrizeLogController/existsPrizeLog|
  24 +|接口说明|拼手气大转盘是否中奖|
  25 +|http请求方式|POST/GET|
  26 +#### 返回错误
  27 +|错误code|错误提示|
  28 +|:-------| -----:|
  29 +|500|参数不合法|
  30 +注意，通用的头部没有列出。
  31 +请求示例
  32 +/activity/UserdayPrizeLogController/existsPrizeLog?uid=12356&prize_type=1
  33 +
  34 +### 响应
  35 +code为200即为成功，否则是失败。
  36 +响应参数，data部分
  37 +响应成功JSON格式如下所示:
  38 +```json
  39 +{
  40 + "alg": "SALT_MD5",
  41 + "code": 200,
  42 + "data": true, // true-中奖，false-未中奖
  43 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  44 + "message": "发送成功."
  45 +}
  46 +```
  47 +响应失败JSON格式如下所示:
  48 +```json
  49 +{
  50 + "message":"参数不合法",
  51 + "code":500
  52 + }
  53 +```
  1 +## 1、查询用户留言##
  2 +
  3 +查询用户留言（/activity/UserdayLeaveWordsController/queryLeaveWordsList）
  4 +#### 公共请求参数
  5 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  7 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  8 +|app_version|float|10|否|1||APP版本|
  9 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  10 +|client_type|string|20|否|iphone/android/ipad||手机型号（不区分大小写）|
  11 +|screen_size|string|20|否|800x900||（手机尺寸）|
  12 +
  13 +#### 请求参数
  14 +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
  15 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  16 +|uid|int|1-11|否|12356||用户uid|
  17 +
  18 +#### 接口说明
  19 +| 接口说明||
  20 +|:-------| -----:|
  21 +|请求域名|http://api.yoho.cn|
  22 +|接口名|/activity/UserdayLeaveWordsController/queryLeaveWordsList|
  23 +|接口说明|查询用户留言|
  24 +|http请求方式|POST/GET|
  25 +#### 返回错误
  26 +|错误code|错误提示|
  27 +|:-------| -----:|
  28 +|500|参数不合法|
  29 +注意，通用的头部没有列出。
  30 +请求示例
  31 +/activity/UserdayLeaveWordsController/queryLeaveWordsList?uid=12356
  32 +
  33 +### 响应
  34 +code为200即为成功，否则是失败。
  35 +响应参数，data部分
  36 +响应成功JSON格式如下所示:
  37 +```json
  38 +{
  39 + "alg": "SALT_MD5",
  40 + "code": 200,
  41 + "data": [
  42 + "我希望有货币可以兑换有货的神券",
  43 + "想参加每年一次的吴亦凡生日会活动",
  44 + "讲真，我开始期待下个月的会员日了",
  45 + "在会员日get到关注已久的潮牌，还有专属价，开心的不要不要的！"
  46 + ],
  47 + "md5": "6d729d4b35f10fc73531210bd7ecff91",
  48 + "message": "发送成功."
  49 +}
  50 +```
  51 +响应失败JSON格式如下所示:
  52 +```json
  53 +{
  54 + "message":"参数不合法",
  55 + "code":500
  56 + }
  57 +```