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
  1 +## 2、学籍认证 ##
  2 +
  3 +学籍认证（?method=app.student.verifyStudent）
  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 +|uid|String|1-11|否|121345||用户uid|
  16 +|client_type|String|1-10|否|web||客户端类型|
  17 +|college_name|String|1-100|否|南京大学||学校名称|
  18 +|education_degree|String|1-10|否|本科||学历层次|
  19 +|enrollment_year|String|1-4|否|2011||入学年份|
  20 +|graduate_year|String|1-4|是|2015||毕业年份|
  21 +|education_category|String|1|是|1||学籍类型：1：表示普通全日制； 2：表示硕士或者博士研究生； 5：表示成人教育； 6：表示高等教育自学考试； 7：表示网络教育； 8：表示开放教育； 9：表示不详|
  22 +|token|String|1-100|否|132165642189798713||身份认证返回url中的token参数|
  23 +#### 接口说明
  24 +| 接口说明||
  25 +|:-------| -----:|
  26 +|请求域名|http://api.yoho.cn|
  27 +|接口名|app.student.verifyStudent|
  28 +|学籍认证|
  29 +|http请求方式|POST/GET|
  30 +#### 返回错误
  31 +无
  32 +注意，通用的头部没有列出。
  33 +请求示例
  34 +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
  35 +
  36 +### 响应
  37 +code为200即为成功，否则是失败。
  38 +响应参数，data部分
  39 +响应成功JSON格式如下所示:
  40 +```json
  41 +{
  42 + "alg":"SALT_MD5",
  43 + "code":200,
  44 + "data":{
  45 + "isStudent":1, // 1-是，0-否
  46 + "serialNo":1234, // 认证序号
  47 + "prompt":"100有货币已到账" // 认证提示语
  48 + },
  49 + "md5":"f4a7a490bb6666b005008d795ed14e5d",
  50 + "message":"verify student."
  51 +}
  52 +```
  1 +## 1、获取学历层次列表 ##
  2 +
  3 +获取学历层次列表（?method=app.studentMarket.getEducationLevelList）
  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 +|:-------| -----:|
  17 +|请求域名|http://api.yoho.cn|
  18 +|接口名|app.studentMarket.getEducationLevelList|
  19 +|获取学历层次列表|
  20 +|http请求方式|POST/GET|
  21 +#### 返回错误
  22 +无
  23 +注意，通用的头部没有列出。
  24 +请求示例
  25 +http://192.168.102.205:8080/gateway?method=app.studentMarket.getEducationLevelList
  26 +
  27 +### 响应
  28 +code为200即为成功，否则是失败。
  29 +响应参数，data部分
  30 +响应成功JSON格式如下所示:
  31 +```json
  32 +{
  33 + "alg":"SALT_MD5",
  34 + "code":200,
  35 + "data":[
  36 + "博士","硕士","本科","专科","成人"
  37 + ],
  38 + "md5":"f4a7a490bb6666b005008d795ed14e5d",
  39 + "message":"Address list."
  40 +}
  41 +```
  1 +## 2、查询学校列表 ##
  2 +
  3 +查询学校列表（?method=app.studentMarket.getSchoolInfoList）
  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 +|areaCode|String|1-2|否|32||省份code|
  16 +#### 接口说明
  17 +| 接口说明||
  18 +|:-------| -----:|
  19 +|请求域名|http://api.yoho.cn|
  20 +|接口名|app.studentMarket.getSchoolInfoList|
  21 +|查询学校列表|
  22 +|http请求方式|POST/GET|
  23 +#### 返回错误
  24 +无
  25 +注意，通用的头部没有列出。
  26 +请求示例
  27 +http://192.168.102.205:8080/gateway?method=app.studentMarket.getSchoolInfoList&areaCode=32
  28 +
  29 +### 响应
  30 +code为200即为成功，否则是失败。
  31 +响应参数，data部分
  32 +响应成功JSON格式如下所示:
  33 +```json
  34 +{
  35 + "alg":"SALT_MD5",
  36 + "code":200,
  37 + "data":[
  38 + {
  39 + "id":1,
  40 + "addresseeName":"北京",
  41 + "areaCode":11,
  42 + "schoolCode":10030,
  43 + "schoolName":"北京外国语大学",
  44 + "groupBy":"B"
  45 + },
  46 + {
  47 + "id":1,
  48 + "addresseeName":"安徽",
  49 + "areaCode":34,
  50 + "schoolCode":14298,
  51 + "schoolName":"安徽汽车职业技术学院",
  52 + "groupBy":"A"
  53 + }
  54 + ],
  55 + "md5":"f4a7a490bb6666b005008d795ed14e5d",
  56 + "message":"School list."
  57 +}
  58 +```
  1 +## 1、获取完成认证学生总数 ##
  2 +
  3 +获取完成认证学生总数（?method=app.student.verifiedStudentTotal）
  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 +|:-------| -----:|
  17 +|请求域名|http://api.yoho.cn|
  18 +|接口名|app.student.verifiedStudentTotal|
  19 +|获取完成认证学生总数|
  20 +|http请求方式|POST/GET|
  21 +#### 返回错误
  22 +无
  23 +注意，通用的头部没有列出。
  24 +请求示例
  25 +http://192.168.102.205:8080/gateway?method=app.student.verifiedStudentTotal
  26 +
  27 +### 响应
  28 +code为200即为成功，否则是失败。
  29 +响应参数，data部分
  30 +响应成功JSON格式如下所示:
  31 +```json
  32 +{
  33 + "alg":"SALT_MD5",
  34 + "code":200,
  35 + "data":235641,
  36 + "md5":"f4a7a490bb6666b005008d795ed14e5d",
  37 + "message":"verifiedStudentTotal total."
  38 +}
  39 +```
  1 +## 1、获取省份列表 ##
  2 +
  3 +获取省份列表（?method=app.studentMarket.getAddressList）
  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 +|:-------| -----:|
  17 +|请求域名|http://api.yoho.cn|
  18 +|接口名|app.studentMarket.getAddressList|
  19 +|获取省份列表|
  20 +|http请求方式|POST/GET|
  21 +#### 返回错误
  22 +无
  23 +注意，通用的头部没有列出。
  24 +请求示例
  25 +http://192.168.102.205:8080/gateway?method=app.studentMarket.getAddressList
  26 +
  27 +### 响应
  28 +code为200即为成功，否则是失败。
  29 +响应参数，data部分
  30 +响应成功JSON格式如下所示:
  31 +```json
  32 +{
  33 + "alg":"SALT_MD5",
  34 + "code":200,
  35 + "data":[
  36 + {
  37 + "id":1,
  38 + "addresseeName":"北京",
  39 + "areaCode":"11",
  40 + "groupBy":"B"
  41 + },
  42 + {
  43 + "id":2,
  44 + "addresseeName":"江苏",
  45 + "areaCode":"32",
  46 + "groupBy":"J"
  47 + }
  48 + ],
  49 + "md5":"f4a7a490bb6666b005008d795ed14e5d",
  50 + "message":"Address list."
  51 +}
  52 +```
  1 +## 2、身份认证 ##
  2 +
  3 +身份认证（?method=app.student.verifyIdentity）
  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 +|uid|String|1-11|否|121345||用户uid|
  16 +|client_type|String|1-10|否|web||客户端类型|
  17 +|cert_no|String|1-18|否|320111199012251456||身份证号|
  18 +|name|String|1-10|否|张三||姓名|
  19 +|mobile_no|String|1-11|是|15689425369||手机号|
  20 +|page_url|String|1-100|否|http://xxxx.com||页面回调地址|
  21 +#### 接口说明
  22 +| 接口说明||
  23 +|:-------| -----:|
  24 +|请求域名|http://api.yoho.cn|
  25 +|接口名|app.student.verifyIdentity|
  26 +|身份认证|
  27 +|http请求方式|POST/GET|
  28 +#### 返回错误
  29 +无
  30 +注意，通用的头部没有列出。
  31 +请求示例
  32 +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
  33 +
  34 +### 响应
  35 +code为200即为成功，否则是失败。
  36 +响应参数，data部分
  37 +响应成功JSON格式如下所示:
  38 +```json
  39 +{
  40 + "alg":"SALT_MD5",
  41 + "code":200,
  42 + "data":"http://xxx.com",
  43 + "md5":"f4a7a490bb6666b005008d795ed14e5d",
  44 + "message":"verify identity."
  45 +}
  46 +```