认证类接口

主要使用场景:开发者可以通过该接口进行oauth认证、实名认证等操作

1、获取访问oauth临时码

获取访问oauth访问临时码,用来验证accessToken中的应用信息;每次访问oauth时需要重新获取,使用一次后销毁。

请求说明

url /oauth/createOauthTicket
协议 post

参数说明

序列号 字段名 约束 类型 说明
1 accessToken 必选 String 访问令牌

返回说明

序列号 字段名 约束 类型 说明
1 retCode 必选 String 返回码 000000:成功 200001: 必选参数为空 300006: 用户会话票据失效
2 retDesc 必选 String 返回码描述
3 accessTicket 必选 String 临时访问码

示例

请求报文:
{ 
 "accessToken":"a2918149d8674ee290f911a08963fe01" 
}

应答报文:
{
   "accessTicket": "f98ef43a11b94444a29a87e7f4cdeca7",
   "retCode": "000000",
   "retDesc": "获取accessTicket成功"
}

2、获取用户实名信息

获取第三方应用的用户实名认证信息

请求说明

url /cert/getCertInfo
协议 post

参数说明

序列号 字段名 约束 类型 说明
1 usessionId 必选 String 会话id,唯一标识一个登录用户

返回说明

序列号 字段名 约束 类型 说明
1 retCode 必选 String 返回码 000000:成功 200001:必选参数为空 200002:请求参数错误 300006:用户会话票据失效
2 retDesc 必选 String 返回码描述
3 data 可选 JSON 返回JSON
3.1 createTime 可选 Date 认证时间
3.2 name 可选 String 实名用户名称
3.3 sysCode 可选 String 系统编码
3.4 loginAccount 可选 String 登录账号
3.5 comeFrom 可选 String 来源平台/应用

示例

请求报文:
{"usessionId":"c884cc21-6******",
}
应答报文:
{
   "retCode": "000000",
   "retDesc": "成功",
   "data": [
    {
      "createTime": "2017-12-20 10:37:21",
      "name": "韦雄强",
      "sysCode": "0",
      "loginAccount": "s***zc",
      "comeFrom": "国家教育资源公共服务平台"
    }
  ]
}

3、空接口测试

空接口测试

请求说明

url /cert/testEmpty
协议 post

参数说明

序列号 字段名 约束 类型 说明

返回说明

序列号 字段名 约束 类型 说明

示例

请求报文:
{"usessionId":"c884cc21-6******",
}
应答报文:
{
   "retCode": "000000",
   "retDesc": "成功",
   "data": [
    {
      "createTime": "2017-12-20 10:37:21",
      "name": "韦雄强",
      "sysCode": "0",
      "loginAccount": "s***zc",
      "comeFrom": "国家教育资源公共服务平台"
    }
  ]
}

4、应用用户登记

应用访问体系登记使用情况。

请求说明

url /cert/independentAppRegister
协议 post

参数说明

序列号 字段名 约束 类型 说明
1 userId 必选 String 应用用户ID
2 loginAccount 必选 String 应用登录账号
3 phone 可选 String 手机号码
4 name 可选 String 用户姓名
5 gender 可选 String 性别(1:男, 2:女)
6 type 必选 String 登记类型(0:接口登记, 1:页 面登记)
7 orgId 必选 String 机构 ID(可根据机构编码信息接口获取 )
8 userIdentity 必选 String 身份(0 学生, 1 老师, 2 家长, 3 学校工作人员, 4 机构工作人员)
9 orgName 必选 String 机构名称(第三方)
10 provinceCode 必选 String 区域编码-省(第三方)
11 cityCode 必选 String 区域编码-市(第三方)
12 areaCode 必选 String 区域编码-区/县(第三方)
13 province 必选 String 区域名称-省(第三方)
14 city 必选 String 区域名称-市(第三方)
15 area 必选 String 区域名称-区/县(第三方)

返回说明

序列号 字段名 约束 类型 说明
1 retCode 必选 String 返回码 000000:成功 200001:必选参数为空 300032:该用户未登记过,请跳转 登记页面进行登记。
2 retDesc 必选 String 返回码描述
3 data 可选 String (当 type 为 1 时,如之前从未登记,返回登记页面 url)
3.1 registerUrl 可选 String 该用户未登记过请跳转登记页面 进行登记!

示例

请求报文:
{ 
"userId" : "1234",
"loginAccount": "12345678901",
"type": "0",
"orgId": "12345678901",
"userIdentity" :"0"
}

 应答报文:
{
“retCode” : “000000” ,
“retDesc” : “成功”
}

5、应用关联体系实名用户

应用用户通过平台认证获取体系id和app对应账号信息,进行实名认证。

请求说明

url /cert/independentAppValidateUser
协议 post

参数说明

序列号 字段名 约束 类型 说明
1 userId 必选 String 应用用户id
2 loginAccount 必选 String 应用登录账号
3 personId 必选 String 体系用户id

返回说明

序列号 字段名 约束 类型 说明
1 retCode 必选 String 返回码 000000:成功 200001:必选参数为空 300029:该平台用户实名信息不存在! 300030:该app用户已实名!
2 retDesc 必选 String 返回码描述

示例

请求报文:
{
  "userId": "1234",
  "loginAccount": "12345678901",
"personId": "12345678901"
}
应答报文:
{
  "retCode": "000000",
  "retDesc": "success"