Skip to content

校园卡门禁

获取门禁列表

描述

查询应用所属权限的门禁列表

支持的模式

  • client_credentials

请求方法

GET

请求地址

https://api.ecnu.edu.cn/api/v1/ecard/door/terms

请求参数

返回参数

参数名类型备注
termIdnumber设备编号
termnamestring设备名称
extendIdnumber分控器编号
extendNamestring分控器名称

请求示例


curl -H "Authorization: Bearer 5956629b6715bcddad8e77516c13b183"  https://api.ecnu.edu.cn/api/v1/ecard/door/terms

返回示例

json
{
	"errCode": 0,
	"errMsg": "success",
	"requestId": "cbb8400e-8016-4437-8287-1d06fee51c44",
	"data": [{
		"termId": ****,
		"termname": "文科楼***",
		"extendId": ****,
		"extendName": "进读卡器"
	}]

下发门禁授权

描述

给门禁下发授权

支持的模式

  • client_credentials

请求方法

POST

请求地址

https://api.ecnu.edu.cn/api/v1/ecard/door/authorize

请求参数

content-type: application/json 方式,在 body 内提交请求参数

参数名类型备注
userIdstring学工号
namestring姓名,必须要和学工号相匹配
termIdnumber设备编号,必须是有权限的门禁设备
extendIdnumber分控器编号,必须和设备编号相匹配
grantTypenumber0授禁,1授权
grantStartdtnumber授权起始时间,unix 时间戳
grantEnddtnumber授权结束时间,unix 时间戳,必须比起始时间大,且不得小于当前时间

返回参数

参数名类型备注
pkidnumber同步编号,可根据此编号查询授权同步状态
userIdstring学工号
termIdnumber设备编号
extendIdnumber分控器编号
grantTypenumber0授禁,1授权
grantStartdtstring授权起始时间
grantEnddtstring授权结束时间
upDateFlagnumber授权同步状态,1未同步,99完成同步
upDateDTstring授权写入的时间(即接口调用的时间)
downDTstring授权完成同步的时间

请求示例

curl -X POST -H "Authorization: Bearer 5956629b6715bcddad8e77516c13b183" -H "content-type: application/json" -d "{\"userId\":\"20****73\",\"name\":\"冯*\",\"termId\":2885,\"extendId\":1021,\"grantType\":1,\"grantStartdt\":1622623855,\"grantEnddt\":1623315055}" https://api.ecnu.edu.cn/api/v1/ecard/door/authorize

返回示例

json
{
	"errCode": 0,
	"errMsg": "success",
	"requestId": "7f826db9-0ca8-4112-ac61-4c8f21f56103",
	"data": {
		"pkid": "1********5-2fd1e2a5-3d79-49f1-b496-fbb26b2755ae",
		"userId": "20****73",
		"termId": ***,
		"extendId": ****,
		"grantType": 1,
		"grantStartdt": "2021-06-02 16:50:55",
		"grantEnddt": "2021-06-10 16:50:55",
		"upDateFlag": 1,
		"upDateDT": "2021-06-02 16:53:15",
		"downDT": "
	}
}

查询门禁授权同步状态

描述

查询门禁授权同步的状态

支持的模式

  • client_credentials

请求方法

GET

请求地址

https://api.ecnu.edu.cn/api/v1/ecard/door/authorize

请求参数

参数名是否必填备注
pkid同步编号

返回参数

参数名类型备注
pkidstring同步编号,可根据此编号查询授权同步状态
userIdstring学工号
termIdnumber设备编号
extendIdnumber分控器编号
grantTypenumber0授禁,1授权
grantStartdtstring授权起始时间
grantEnddtstring授权结束时间
upDateFlagnumber授权同步状态,1未同步,99完成同步
upDateDTstring授权写入的时间(即接口调用的时间)
downDTstring授权完成同步的时间

请求示例

curl -H "Authorization: Bearer 5956629b6715bcddad8e77516c13b183"  https://api.ecnu.edu.cn/api/v1/ecard/door/authorize?pkid=1******5-2fd1e2a5-3d79-49f1-b496-fbb26b2755ae

返回示例

json
{
	"errCode": 0,
	"errMsg": "success",
	"requestId": "7f826db9-0ca8-4112-ac61-4c8f21f56103",
	"data": {
		"pkid": "1********5-2fd1e2a5-3d79-49f1-b496-fbb26b2755ae",
		"userId": "20****73",
		"termId": ***,
		"extendId": ***,
		"grantType": 1,
		"grantStartdt": "2021-06-02 16:50:55",
		"grantEnddt": "2021-06-10 16:50:55",
		"upDateFlag": 99,
		"upDateDT": "2021-06-02 16:53:15",
		"downDT": "2021-06-02 16:53:38"
	}
}

查询门禁用户权限

描述

根据 userId,查询他拥有权限的门禁设备清单

在授权码/密码模式下,将返回用户有权限的全部的门禁设备

在客户端模式下,仅返回该用户在应用方可见范围内的有权限设备(即 /api/v1/ecard/door/terms 中可获取的部分)

支持的模式

  • authorization_code
  • client_credentials
  • password

请求方法

GET

请求地址

https://api.ecnu.edu.cn/api/v1/ecard/door/grants/user

请求参数

参数名是否必填备注
userId学工号

返回参数

参数名类型备注
userIdstring学工号
startTimestring权限开始的时间
endTimestring权限结束的时间
termIdnumber设备编号
termnamestring设备名称
extendIdnumber分控器编号
extendNamestring分控器名称

请求示例

curl -H "Authorization: Bearer 5956629b6715bcddad8e77516c13b183"  https://api.ecnu.edu.cn/api/v1/ecard/door/grants/user?userId=20***15

返回示例

json
{
	"errCode": 0,
	"errMsg": "success",
	"requestId": "42e5f768-74c4-459e-9dac-33f1b69a1c6c",
	"data": [{
		"userId": "20****3",
		"startTime": "2022-09-07 00:00:00",
		"endTime": "2099-12-31 23:59:59",
		"termId": ***,
		"termname": "信息办****后门",
		"extendId": ***,
		"extendName": "信息办***后门"
	}, {
		"userId": "20***73",
		"startTime": "2021-04-16 00:00:00",
		"endTime": "2099-12-31 00:00:00",
		"termId": ***,
		"termname": "老图书馆***大门",
		"extendId": ***,
		"extendName": "老图书馆***大门"
	}]
}

查询门禁设备权限

描述

根据设备,查询该门禁有权限的用户清单

支持的模式

  • client_credentials

请求方法

GET

请求地址

https://api.ecnu.edu.cn/api/v1/ecard/door/grants/term

请求参数

参数名是否必填备注
termId设备编号
extendId分控器编号

返回参数

参数名类型备注
userIdstring学工号
startTimestring权限开始的时间
endTimestring权限结束的时间
termIdnumber设备编号
termnamestring设备名称
extendIdnumber分控器编号
extendNamestring分控器名称

请求示例

curl -H "Authorization: Bearer 5956629b6715bcddad8e77516c13b183"  https://api.ecnu.edu.cn/api/v1/ecard/door/grants/term?termId=*****&extendId=***

返回示例

json
{
	"errCode": 0,
	"errMsg": "success",
	"requestId": "e801f075-e1b1-4359-9240-7c1dd013bc8b",
	"data": [{
		"userId": "19***35",
		"startTime": "2022-09-07 00:00:00",
		"endTime": "2099-12-31 23:59:59",
		"termId": ***,
		"termname": "信息办****后门",
		"extendId": ***,
		"extendName": "信息办***后门"
	}, {
		"userId": "20***05",
		"startTime": "2022-09-07 00:00:00",
		"endTime": "2099-12-31 23:59:59",
		"termId": ***,
		"termname": "信息办****后门",
		"extendId": ***,
		"extendName": "信息办***后门"
	}]
}

查询门禁用户记录

描述

根据 userId,查询他的门禁记录

在授权码/密码模式下,将返回用户全部的门禁记录

在客户端模式下,仅返回该用户在应用方可见范围内的门禁记录(即 /api/v1/ecard/door/terms 中可获取的部分)

支持的模式

  • authorization_code
  • client_credentials
  • password

请求方法

GET

请求地址

https://api.ecnu.edu.cn/api/v1/ecard/door/records/user

请求参数

参数名是否必填备注
userId学工号
startTime开始的时间戳
endTime结束时间的时间戳,最大不超过30天

返回参数

参数名类型备注
userIdstring学工号
namestring姓名
operTimestring时间
termIdnumber设备编号
termnamestring设备名称
extendIdnumber分控器编号
extendNamestring分控器名称
ioFlagnumber进门出门区分,0进1出
successbool成功开门标志,true/false
recordTypeNamestring开门的记录说明

请求示例

curl -H "Authorization: Bearer 5956629b6715bcddad8e77516c13b183"  https://api.ecnu.edu.cn/api/v1/ecard/door/records/user?startTime=1663465067&endTime=1664329068&userId=20****73

返回示例

json
{
	"errCode": 0,
	"errMsg": "success",
	"requestId": "431a63e7-f0fd-46d9-9730-a2480f7cd8f3",
	"data": [{
		"userId": "20***73",
		"name": "冯*",
		"operTime": "2022-09-22 17:53:34",
		"termId": ***,
		"termName": "老图书馆**大门",
		"extendId": **,
		"extendTermName": "老图书馆***大门",
		"ioFlag": 0,
		"success": true,
		"recordTypeName": "正常开门"
	}, {
		"userId": "20***73",
		"name": "冯*",
		"operTime": "2022-09-22 17:54:02",
		"termId": ***,
		"termName": "信息办***后门",
		"extendId": ***,
		"extendTermName": "信息办***后门",
		"ioFlag": 1,
		"success": true,
		"recordTypeName": "正常开门"
	}]
}

查询门禁设备记录

描述

根据门禁设备的编号,查询此门禁的刷卡记录

支持的模式

  • client_credentials

请求方法

GET

请求地址

https://api.ecnu.edu.cn/api/v1/ecard/door/records/term

请求参数

参数名是否必填备注
termId设备编号
extendId分控器编号
startTime开始的时间戳
endTime结束时间的时间戳,最大不超过30天

返回参数

参数名类型备注
userIdstring学工号
namestring姓名
operTimestring时间
termIdnumber设备编号
termnamestring设备名称
extendIdnumber分控器编号
extendNamestring分控器名称
ioFlagnumber进门出门区分,0进1出
successbool成功开门标志,true/false
recordTypeNamestring开门的记录说明

请求示例

curl -H "Authorization: Bearer 5956629b6715bcddad8e77516c13b183"  https://api.ecnu.edu.cn/api/v1/ecard/door/records/term?termId=1808&extendId=11&startTime=1663465067&endTime=1664329068

返回示例

json
{
	"errCode": 0,
	"errMsg": "success",
	"requestId": "431a63e7-f0fd-46d9-9730-a2480f7cd8f3",
	"data": [{
		"userId": "20***73",
		"name": "冯*",
		"operTime": "2022-09-22 17:53:34",
		"termId": ***,
		"termName": "老图书馆**大门",
		"extendId": **,
		"extendTermName": "老图书馆***大门",
		"ioFlag": 0,
		"success": true,
		"recordTypeName": "正常开门"
	}, {
		"userId": "20***73",
		"name": "冯*",
		"operTime": "2022-09-22 17:54:02",
		"termId": ***,
		"termName": "信息办***后门",
		"extendId": ***,
		"extendTermName": "信息办***后门",
		"ioFlag": 1,
		"success": true,
		"recordTypeName": "正常开门"
	}]
}