考试星登录接口文档

• 考试星登录接口文档
• 考试星数据接口文档
• 考试星对外推送接口文档
• 示例代码
• SHA256加密示例（java）
• 上传人脸识别照片

1.api接口说明

• 考试星api接口采用jwt规范。Json web token (JWT), 是为了在网络应用环境间传递声明而执行的一种基于JSON的开放标准（(RFC 7519).该token被设计为紧凑且安全的，特别适用于分布式站点的单点登录（SSO）场景。JWT调用示例代码

2.api参数配置

• appId : 客户唯一标识符，由考试星提供，例如：14343。
• appKey : 用于加密jwt，由考试星提供，例如：xf5ha3h67h4Ger34wh35p345h4。
• 获取方式：【管理员后台：系统设置->更多设置->开发者信息管理】

3.api统一接口地址

• 地址： https://api.kaoshixing.com/api/company/data/:appId/?jwt=:jwtInfo
• jwtInfo：jwt_info是用户根据jwt规范，用app_key将过期时间、action_id加密，生成的加密字符串

4.生成加密jwtInfo（java示例）

(1).安装依赖

<dependency>
  <groupId>io.jsonwebtoken</groupId>
  <artifactId>jjwt</artifactId>
  <version>0.7.0</version>
</dependency>

(2).生成加密字符串

生成jwtInfo加密字符串

  import io.jsonwebtoken.Jwts;
  String appKey = “xf5ha3h67h4Ger34wh35p345h4”
  String jwtInfo = Jwts.builder()
           .claim("exp", System. currentTimeMillis() + 1000*10)
              .claim("action_id", "201")
            .signWith(SignatureAlgorithm.HS256,app_key.getBytes("UTF-8") ).compact();

(3).加密参数解释

appKey：加密的私钥，由考试星提供。
exp：过期时间。
action_id：表示登录考试星动作(注意是下划线)。

5.action_id参数解释

6.当前开放的请求接口

(1)考生登录请求接口：

action_id = 201

时序图：

请求地址：https://api.kaoshixing.com/api/company/data/:appId/?jwt=:jwtInfo

请求方法：post

请求参数：

返回结果：

{
  "code":10000,
  "msg": "success", 
  "url":"https://api.kaoshixing.com/api/company/redirect/13245/?
  jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjo1LCJleHAiOj
  E0OTQiOiIyMDEifQ.I3j56t_tVMX1GrIktqFRienFZTJ7VKgc6lPs&customurl=xxx"}

拿到结果后重定向到这个url地址，考生即可登录到考试星。

(2)、考生信息更新

action_id = 202

请求地址：https://api.kaoshixing.com/api/company/data/:appId/?jwt=:jwtInfo

请求方式：POST

请求参数：

参数说明：除了user_id以外，还至少需要一个

正确返回

{
  "code":10000,
  "msg": "更新考生信息成功"
}

错误返回：

{
    "code":31000,
    "msg":"该考生不存在"/"更新考生部门失败"/"更新考生信息失败"
}

(3)、考生静默登录

action_id = 203

请求地址：https://api.kaoshixing.com/api/company/data/:appId/?jwt=:jwtInfo

请求方式：POST

请求参数：

返回结果：

{
  "code":10000,
  "msg": "success", 
"url":"https://api.kaoshixing.com/api/company/redirect/13245/?
jwt=eyJhbGci5faWQiOiIyMDEifQ.I3j56t_tVMX1GgH62dy-rIktqFRienFZTJ7VKgc6lPs"}

拿到结果后重定向到这个url地址，考生即可登录到考试星。

登录成功的返回结果：

{
    "success":true,
    "code":10000,
    "desc":"成功",
    "bizContent":null
}

登录失败的返回结果：

{
    "success":false,
    "code":31014,
    "desc":"用户不存在",
    "englishDesc":"user not existed",
    "bizContent":null
}

(4)、获取JWT

action_id = 206

请求地址：https://api.kaoshixing.com/api/company/data/:appId/?jwt=:jwtInfo

请求方式：POST

请求参数：

返回结果：

{
    "msg": "success",
    "jwt": "etJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2NTc1MTkwNjMyMDgsInVzZXJfaWQiOjIxMDM4OTkyLCJhY3Rpb25faWQiOiIyMDYifQ.Rr_nCUdWJ27gZtX4IMrL2_gLe3TdJXk4nYXux-ReZ8",
    "code": 10000
}

(5)、添加、删除考生考试权限

action_id = 207

请求地址：https://api.kaoshixing.com/api/company/data/:appId/?jwt=:jwtInfo

请求方式：POST

请求参数：

(6)、修改部门归属

action_id = 208

请求地址：https://api.kaoshixing.com/api/company/data/:appId/?jwt=:jwtInfo

请求方式：POST

请求参数：

参数说明：将depName对应的部门移动到pDepName下面

请求成功时的响应:

{
    "msg": "success",
    "code": 10000
}

请求失败时的响应:

{
    "msg": "更新部门失败",
    "code": "0042"
}

(7)、查询考生信息

action_id = 209

请求地址：https://api.kaoshixing.com/api/company/data/:appId/?jwt=:jwtInfo

请求方式：POST

请求参数：

参数说明：根据考生账号查询考生详细信息

请求成功时的响应:

{
	"total": 1,
	"current": 1,
	"rowCount": 1,
	"rows": [{
		"user_id": "zhangsan",
		"user_name": "张三",
		"department": "部门分类",
		"sex": "-1",
		"phone": "1234567890",
		"notice": "备注",
		"position": "职位",
		"field1": "自定义字段1",
		"field2": "自定义字段2",
		"field3": "自定义字段3",
		"field4": "自定义字段4",
		"field5": "自定义字段5",
		"identity_card": "1234567890"
	}]
}

请求失败时的响应:

{
    "msg": "参数获取不到",
    "code": "0005"
}