Authored by jack xue
## 2、学籍认证 ##
学籍认证(?method=app.student.verifyStudent)
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|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|String|1-11|否|121345||用户uid|
|client_type|String|1-10|否|web||客户端类型|
|college_name|String|1-100|否|南京大学||学校名称|
|education_degree|String|1-10|否|本科||学历层次|
|enrollment_year|String|1-4|否|2011||入学年份|
|graduate_year|String|1-4|是|2015||毕业年份|
|education_category|String|1|是|1||学籍类型:1:表示普通全日制; 2:表示硕士或者博士研究生; 5:表示成人教育; 6:表示高等教育自学考试; 7:表示网络教育; 8:表示开放教育; 9:表示不详|
|token|String|1-100|否|132165642189798713||身份认证返回url中的token参数|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|app.student.verifyStudent|
|学籍认证|
|http请求方式|POST/GET|
#### 返回错误
注意,通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway?method=app.student.verifyStudent&uid=32&client_type=web&college_name=南京大学&education_degree=本科&enrollment_year=2011&token=132165642189798713
### 响应
code为200即为成功,否则是失败。
响应参数,data部分
响应成功JSON格式如下所示:
```json
{
"alg":"SALT_MD5",
"code":200,
"data":{
"isStudent":1, // 1-是,0-否
"serialNo":1234, // 认证序号
"prompt":"100有货币已到账" // 认证提示语
},
"md5":"f4a7a490bb6666b005008d795ed14e5d",
"message":"verify student."
}
```
... ...
... ... @@ -40,14 +40,16 @@ code为200即为成功,否则是失败。
"addresseeName":"北京",
"areaCode":11,
"schoolCode":10030,
"schoolName":"北京外国语大学"
"schoolName":"北京外国语大学",
"groupBy":"B"
},
{
"id":1,
"addresseeName":"安徽",
"areaCode":34,
"schoolCode":14298,
"schoolName":"安徽汽车职业技术学院"
"schoolName":"安徽汽车职业技术学院",
"groupBy":"A"
}
],
"md5":"f4a7a490bb6666b005008d795ed14e5d",
... ...
## 1、获取完成认证学生总数 ##
获取完成认证学生总数(?method=app.student.verifiedStudentTotal)
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|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||(手机尺寸)|
#### 请求参数
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|app.student.verifiedStudentTotal|
|获取完成认证学生总数|
|http请求方式|POST/GET|
#### 返回错误
注意,通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway?method=app.student.verifiedStudentTotal
### 响应
code为200即为成功,否则是失败。
响应参数,data部分
响应成功JSON格式如下所示:
```json
{
"alg":"SALT_MD5",
"code":200,
"data":235641,
"md5":"f4a7a490bb6666b005008d795ed14e5d",
"message":"verifiedStudentTotal total."
}
```
... ...
... ... @@ -36,12 +36,14 @@ code为200即为成功,否则是失败。
{
"id":1,
"addresseeName":"北京",
"areaCode":"11"
"areaCode":"11",
"groupBy":"B"
},
{
"id":2,
"addresseeName":"江苏",
"areaCode":"32"
"areaCode":"32",
"groupBy":"J"
}
],
"md5":"f4a7a490bb6666b005008d795ed14e5d",
... ...
## 2、身份认证 ##
身份认证(?method=app.student.verifyIdentity)
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|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|String|1-11|否|121345||用户uid|
|client_type|String|1-10|否|web||客户端类型|
|cert_no|String|1-18|否|320111199012251456||身份证号|
|name|String|1-10|否|张三||姓名|
|mobile_no|String|1-11|是|15689425369||手机号|
|page_url|String|1-100|否|http://xxxx.com||页面回调地址|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|app.student.verifyIdentity|
|身份认证|
|http请求方式|POST/GET|
#### 返回错误
注意,通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway?method=app.student.verifyIdentity&uid=32&client_type=web&cert_no=320111199012251456&name=张三&page_url=http://xxxx.com
### 响应
code为200即为成功,否则是失败。
响应参数,data部分
响应成功JSON格式如下所示:
```json
{
"alg":"SALT_MD5",
"code":200,
"data":"http://xxx.com",
"md5":"f4a7a490bb6666b005008d795ed14e5d",
"message":"verify identity."
}
```
... ...
... ... @@ -1209,6 +1209,7 @@ message: "product comfort"
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|limit|int|是|30|null|返回记录数|
注意,通用的头部没有列出。
请求示例
... ...
... ... @@ -302,6 +302,7 @@ code为200即为成功,否则是失败。
|isMeetCondition|string|Y/N||N|是否满足分期支付条件,APP可根据该字段决定是否灰化分期渠道|
|conditionErrorCode|int|{0,1,2}||0|不满足分期条件的原因:1、不是所有的商品都是分期商品;2、订单金额大于可用额度
|description|String||||描述,如不满足分期条件的原因|
|instalmentDetail|JSON格式||||分期详情|
### 响应
... ... @@ -314,9 +315,46 @@ code为200即为成功,否则是失败。
"code":200,
"data":{
"isOpen":"Y",
"isMeetCondition":"N",
"conditionErrorCode":2,
"description":"订单金额大于可用额度"
"isMeetCondition":"Y",
"conditionErrorCode":0,
"description":"",
"instalmentDetail":[
{
"is_default":"Y",
"is_support":"Y",
"plan_amount_per_name":"不分期($130.00)",
"plan_int_amount_per_name":"无手续费",
"term":1
},
{
"is_default":"N",
"is_support":"Y",
"plan_amount_per_name":"分3期($100.00*3)",
"plan_int_amount_per_name":"手续费$10/期",
"term":3
},
{
"is_default":"N",
"is_support":"Y",
"plan_amount_per_name":"分6期($100.00*3)",
"plan_int_amount_per_name":"手续费$10/期",
"term":6
},
{
"is_default":"N",
"is_support":"Y",
"plan_amount_per_name":"分9期($100.00*3)",
"plan_int_amount_per_name":"手续费$10/期",
"term":9
},
{
"is_default":"N",
"is_support":"Y",
"plan_amount_per_name":"分12期($100.00*3)",
"plan_int_amount_per_name":"手续费$10/期",
"term":12
}
]
},
"md5":"c1d725306fb09dcbf504776d276521cb",
"message":"ok"
... ... @@ -372,29 +410,89 @@ code为200即为成功,否则是失败。
## 10、还款预支付 ##
是否满足分期支付条件(app.instalment.prerepay),JSON格式
是否满足分期支付条件(app.instalment.prerepay)
### 请求
请求JSON格式如下所示:
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|3236556|0|用户id|
|card_id|int|否|||选择还款的银行卡id|
|terminal_type|string|否||mobile|终端类型,默认传mobile|
|terminal_info|string|否|||终端信息,格式为:IMEI_MAC/序列号_SIM|
|user_ip|string|否|||用户ip|
|repay_amount|double|否|||还款总金额,用户选择还几期需要计算出还款总金额|
#### 响应参数
| 参数名称 | 参数类型 | 取值范围 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|isRepaySuccess|string|Y/N||N|还款请求是否成功|
|repayOrderCode|string||||YOHO的还款流水号|
|crfRepayOrderNo|string||||CRF内部还款订单号|
### 响应示例
code为200即为成功,否则是失败。
响应JSON格式如下所示:
```json
{
"uid":123456,
"bankCard":"1324234234123412",
"terminalType":"mobile",
"terminalInof":"${IMEI_MAC}_${SIM}",
"userIp":"192.168.100.100",
"repayList":[
"alg":"SALT_MD5",
"code":200,
"data":{
"isRepaySuccess":"Y",
"repayOrderCode":"23412341234",
"crfRepayOrderNo":"1234324324"
},
"md5":"c1d725306fb09dcbf504776d276521cb",
"message":"ok"
}
```
## 11、还款确认支付 ##
是否满足分期支付条件(app.instalment.confirmrepay)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|3236556|0|用户id|
|repayOrderCode|string|否|||YOHO还款流水号|
|crfRepayOrderNo|string|否|||CRF内部还款订单号|
|phoneNumber|string|否|||用户电话|
|smsCode|string|否|||短信验证码|
|repayTermList|JSON格式||||用户选择的还款期数列表|
#### repayTermList示例
```json
[
{
"index":0,
"orderCode":"1609321260",
"stage":1
"index":1, --分期列表序号
"orderCode":"12343243", --订单号
"termNo":1 --第几期还款
},
{
"index":2,
"orderCode":"14535343",
"termNo":1
},
{
"index":3,
"orderCode":"12343243",
"termNo":2
}
]
}
]
```
### 响应
#### 响应参数
| 参数名称 | 参数类型 | 取值范围 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|isPaySuccess|string|Y/N||N|还款请求是否成功|
|description|string||||描述,比如不成功的原因|
|repayOrderCode|string||||YOHO的还款流水号|
|crfRepayOrderNo|string||||CRF内部还款订单号|
|repayTime|string||||还款时间|
### 响应示例
code为200即为成功,否则是失败。
响应JSON格式如下所示:
... ... @@ -403,10 +501,13 @@ code为200即为成功,否则是失败。
"alg":"SALT_MD5",
"code":200,
"data":{
"isRepaySuccess":"Y",
"description":"",
"repayOrderCode":"23412341234",
"repayCrfNo":"1234324324"
"crfRepayOrderNo":"1234324324",
"repayTime":"201608052033"
},
"md5":"c1d725306fb09dcbf504776d276521cb",
"message":"ok"
}
```
\ No newline at end of file
```
... ...
... ... @@ -64,6 +64,7 @@ currCreditLimit:当前额度 (status=2时才有此项,如果为"",数值展示
| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|cardNo|String|20|否|8000000021211||银行卡号|
|uid|String|11|否|8000000||用户id|
#### 接口说明
... ... @@ -80,7 +81,7 @@ currCreditLimit:当前额度 (status=2时才有此项,如果为"",数值展示
注意,通用的头部没有列出。
请求示例
?method=user.instalment.getBankInfoByCardNo&cardNo=8000000021211
?method=user.instalment.getBankInfoByCardNo&cardNo=8000000021211&uid=8000000
### 响应
code为200即为成功,否则是失败。
... ... @@ -134,7 +135,7 @@ businessSupport:是否支持("0"支持 "1"不支持)
注意,通用的头部没有列出。
请求示例
?method=user.instalment.getSnsCheckCode&uid=8000000&mobile=18021522255
?method=user.instalment.getSnsCheckCode&uid=8000000&mobile=18021522255&codeType=1
### 响应
code为200即为成功,否则是失败。
... ... @@ -299,7 +300,8 @@ mobile:手机号
{
"alg":"SALT_MD5",
"code":200,
"data":[{userName:"张三",cardNo:"25202200000",bankCode:"ABC",bankName:"农业银行",mobile="18021200000"},{userName:"张三",cardNo:"15202200000",bankCode:"ICBC",bankName:"工商银行",,mobile="18021200001"}],
"data":[{id:"1",userName:"*三",cardNo:"0000",bankCode:"ABC",bankName:"农业银行",mobile="18021200000"},{id:"2",userName:"*三",cardNo:"00001",bankCode:"ICBC",bankName:"工商银行",,mobile="18021200001"}],
"md5":"6d729d4b35f10fc73531210bd7ecff91",
"message":"success"
}
\ No newline at end of file
}
... ...
... ... @@ -31,7 +31,9 @@
-------------------------
|错误码code|消息|
|----------|----|
|401|uid不存在|
|500|不存在该用户|
|500|yohood门票类型为空|
|500|yohood门票为空|
#### 响应内容
```json
... ...
... ... @@ -20,6 +20,7 @@
| type | int | 是 | 1 | | 订单类型 1:全部订单,2:还款中,3:已还清<br />|
| page | int | 否 | 1 | 1 | 页数 |
| limit | int | 否 | 10 | 10 | 每页大小 |
| client_type |String | 是 | H5 | | 客户端类型 |
### 正常返回结果
```json
{
... ... @@ -37,6 +38,7 @@
"buy_total": 1,
//还款进度状态
"install_status":"已还清", // 类别如: 还款中0/1,已还清,订单已取消,已退款399.00
"status":3 //1放款中2正常3已结清4逾期5订单取消
// 购买商品
"order_goods": [
{
... ... @@ -80,7 +82,8 @@
| :-- | :-- | :-- | :--| :-- | :-- |
| method | string | 是 | app.SpaceOrders.installDetail |||
| uid | int | 是 | 5772257 |||
| order_code | int | 是 | 1519816409 || 订单号 |
| order_code | long| 是 | 1519816409 || 订单号 |
| client_type |String | 是 | H5 | | 客户端类型 |
#### 正常返回结果
... ... @@ -121,6 +124,7 @@
"desc":"已还款" // 已还款,已退款,(时间未到返回时间:)2016-08-26,逾期2天
"curr_date":"【1/3期】",
"sort_id":"1" //1,2,3,4,5
"status": 2 //1正常2结清3已逾期4已退货
}
]
},
... ...
... ... @@ -525,7 +525,7 @@ is_needZhihang N:不需要支行 Y:需要支行
| Param Name | Param Type | Required | Param Value | Desc |
| :-- | --: | --: | --: | --: |
| uid | int | true | 20000154 |用户ID |
| orderCode |Long | true| 160800421 |订单号|
| order_code |Long | true| 160800421 |订单号|
| is_return_counpon |String | true| "Y" |是否退优惠券|
| return_yoho_coin |int| true| 105 |退有货币数量
... ...
... ... @@ -277,12 +277,13 @@ code为200即为成功,否则是失败。
"fast_shopping_cost": 15,
"gain_yoho_coin": 0,
"goods_count": 1,
"instalment": {
"is_support": "Y",
"plan_amount_per_name": "分3期(¥105.41*3)",
"plan_int_amount_per_name": "手续费¥26.08/期",
"term": 3
},
"instalment": {
"is_support": "Y",//是否支持
"plan_amount_per": 326.66,//每期应还金额
"plan_amount_per_name": "分3期(¥326.66*3)",
"plan_int_amount_per_name": "免手续费",
"term": 3 //期数
},
"last_order_amount": 178,
"order_amount": 168,
"promotion_formula": "总计¥178.00=商品金额¥168.00+运费¥10.00",
... ... @@ -391,11 +392,12 @@ code为200即为成功,否则是失败。
"use_red_envelopes": 0,
"use_yoho_coin": 0,
"instalment": {
"is_support": "Y",
"plan_amount_per_name": "分3期(¥105.41*3)",
"plan_int_amount_per_name": "手续费¥26.08/期",
"term": 3
},
"is_support": "Y",//是否支持
"plan_amount_per": 326.66,//每期应还金额
"plan_amount_per_name": "分3期(¥326.66*3)",
"plan_int_amount_per_name": "免手续费",
"term": 3 //期数
},
"is_multi_package":"Y",
"package_list":[{
"supplier_id":"0",
... ... @@ -516,73 +518,7 @@ code为200即为成功,否则是失败。
}
```
## 10、有货账单分期列表 ##
#### 说明
有货账单分期列表 在支付页显示(app.payment.listInstalment)
#### 请求参数
| 参数名称 | 参数类型 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|----:|
|uid|int|否|3236556|0|用户id|
|order_code|long|否|1612345678||订单号|
|client_type|string|否|web|iphone|终端|
### 响应
POST
code为200即为成功,否则是失败。
响应JSON格式如下所示:
```json
{
"alg": "SALT_MD5",
"code": 200,
"data": {
"is_support":"Y",
"list":[
{
"is_default":"Y",
"is_support":"Y",
"plan_amount_per_name":"不分期($130.00)",
"plan_int_amount_per_name":"无手续费",
"term":1
},
{
"is_default":"N",
"is_support":"Y",
"plan_amount_per_name":"分3期($100.00*3)",
"plan_int_amount_per_name":"手续费$10/期",
"term":3
},
{
"is_default":"N",
"is_support":"Y",
"plan_amount_per_name":"分6期($100.00*3)",
"plan_int_amount_per_name":"手续费$10/期",
"term":6
},
{
"is_default":"N",
"is_support":"Y",
"plan_amount_per_name":"分9期($100.00*3)",
"plan_int_amount_per_name":"手续费$10/期",
"term":9
},
{
"is_default":"N",
"is_support":"Y",
"plan_amount_per_name":"分12期($100.00*3)",
"plan_int_amount_per_name":"手续费$10/期",
"term":12
}
],
"orderCode":111,
"uid":1
},
"md5": "47eb4073ca797fd7dc5968de7a20bda2",
"message": "use coupon code."
}
```
## 11、使用优惠码 ##
## 10、使用优惠码 ##
#### 说明
使用优惠码(app.Buynow.usePromotionCode)
#### 请求参数
... ...