Yoho-Documents / API-Interfaces · Commits

Go to a project

Authored by bblu
Commit 4f460b4ed3a67cb1aae3d518784fe9ce3c30cf1f 1 parent 06250f06

学生营销

Inline Side-by-side
Showing 6 changed files with 288 additions and 0 deletions
## 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."
}
```
... ...
## 1、获取学历层次列表 ##
获取学历层次列表（?method=app.studentMarket.getEducationLevelList）
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|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.studentMarket.getEducationLevelList|
|获取学历层次列表|
|http请求方式|POST/GET|
#### 返回错误
无
注意，通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway?method=app.studentMarket.getEducationLevelList
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示:
```json
{
"alg":"SALT_MD5",
"code":200,
"data":[
"博士","硕士","本科","专科","成人"
],
"md5":"f4a7a490bb6666b005008d795ed14e5d",
"message":"Address list."
}
```
... ...
## 2、查询学校列表 ##
查询学校列表（?method=app.studentMarket.getSchoolInfoList）
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|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||（手机尺寸）|
#### 请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|areaCode|String|1-2|否|32||省份code|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|app.studentMarket.getSchoolInfoList|
|查询学校列表|
|http请求方式|POST/GET|
#### 返回错误
无
注意，通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway?method=app.studentMarket.getSchoolInfoList&areaCode=32
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示:
```json
{
"alg":"SALT_MD5",
"code":200,
"data":[
{
"id":1,
"addresseeName":"北京",
"areaCode":11,
"schoolCode":10030,
"schoolName":"北京外国语大学",
"groupBy":"B"
},
{
"id":1,
"addresseeName":"安徽",
"areaCode":34,
"schoolCode":14298,
"schoolName":"安徽汽车职业技术学院",
"groupBy":"A"
}
],
"md5":"f4a7a490bb6666b005008d795ed14e5d",
"message":"School list."
}
```
... ...
## 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."
}
```
... ...
## 1、获取省份列表 ##
获取省份列表（?method=app.studentMarket.getAddressList）
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|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.studentMarket.getAddressList|
|获取省份列表|
|http请求方式|POST/GET|
#### 返回错误
无
注意，通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway?method=app.studentMarket.getAddressList
### 响应
code为200即为成功，否则是失败。
响应参数，data部分
响应成功JSON格式如下所示:
```json
{
"alg":"SALT_MD5",
"code":200,
"data":[
{
"id":1,
"addresseeName":"北京",
"areaCode":"11",
"groupBy":"B"
},
{
"id":2,
"addresseeName":"江苏",
"areaCode":"32",
"groupBy":"J"
}
],
"md5":"f4a7a490bb6666b005008d795ed14e5d",
"message":"Address list."
}
```
... ...
## 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."
}
```
... ...