人脸识别门禁系统接口说明书
Revision record 修订记录
Date 日期 | Revision version 修订版本 | Description 描述 | Author 作者 |
2017-11-20 | 1.0 | 初稿 | |
通过 HTTP POST方式访问如下地址
编码:UTF-8
所有数据以参数json传递，参数内容是JSON格式文本
返回JSON格式数据
添加HTTP包头"Authorization"，值为门禁系统登录密码，经过MD5之后的值，例如"e10adc3949ba59abbe56e057f20f883e"
访问地址 | person/add | |
参数定义 | 说明 | |
请求 | cNbr | 工号，必填，人员唯一标志 |
cType | 1白名单,2黑名单 | |
cTimezone | 时段，空表示所有时段可用 | |
cCheckMode | 可用模式。空表示全部可用。否则是以分号分隔的列表，每项是<255的数值，按位表示(1-IC/ID,2身份证,4条码,8指纹,16人脸)，位间关系为与，表示需要同时刷。 | |
cName | 姓名 | |
cSex | 性别 | |
cNation | 民族 | |
cBirthday | 生日 | |
cAddress | 地址 | |
cId | 证件号码 | |
cIssuer | 发行单位 | |
cEffect | 生效时间 | |
cExpire | 失效时间 | |
cIdImage | 证件图片，base64编码 | |
cIc | IC卡号 | |
cBar | 条码 | |
cFinger | 指纹信息 | |
cBeginTime | 权限生效时间 | |
cEndTime | 权限失效时间 | |
cReason | 添加为黑名单的原由 | |
cPhone | 联系电话 | |
cTime | 添加时间，空则使用当前时间，格式YYY-MM-DD HH24:MI:SS | |
cMobile | 手机号码 | |
cStat | 统计信息，默认为空 | |
cTags | 标志信息，默认为空 | |
cMemo | 备注 | |
cScore | 特别分数，默认为空。如果有值表示此人对比时达到此分数就算通过 | |
应答 | code | 错误码，0表示成功 |
message | 错误信息 | |
访问地址 | person/update |
调用参数与添加人员一致，更新工号cNbr指定的人员的信息
访问地址 | person/delete | |
参数定义 | 说明 | |
请求 | list | Json数组，其元素为一个或者多个工号字符串 |
应答 | list | Json数组，对应多个人员删除的返回结果，每个结果有成员 nbr code message |
code | 返回码 | |
message | 消息描述 | |
示例
请求：
{
"list": [
“NO.00001”,“NO.00003”
]
}
应答：
{
"list": [
{
"nbr": "NO.00001",
"code":0,
"message":”操作成功”
},
{
"nbr": "NO.00002",
"code":0,
"message":”操作成功”
}
]
"code":0,
"message":”操作成功”
}
访问地址 | person/query | |
参数定义 | 说明 | |
请求 | ||
应答 | list | Json数组，每个元素为一个工号字符串，返回系统中所有工号 |
code | 返回码 | |
message | 消息描述 | |
访问地址 | person/get | |
参数定义 | 说明 | |
请求 | list | Json数组，其下每个元素为一个工号字符串 |
应答 | list | Json数组，对应多个人员查询结果，每个结果下的成员与添加操作的成员相同，并且有如下成员表示操作是否成功 nbr code message |
code | 返回码 | |
message | 消息描述 | |
访问地址 | record/queryLog | |
参数定义 | 说明 | |
请求 | starttime | 开始时间 |
endtime | 结束时间 | |
offset | 针对多条记录分页返回 指定起始位置 | |
count | 返回记录数量 | |
应答 | code | 返回码 |
message | 消息描述 | |
list | Json数组，日志记录列表。每个元素有如下信息 | |
应答返回的list列表中每个对象包含如下信息：
cRecId | 记录标志 |
cNbr | 工号 |
cTime | 刷卡、脸时间 |
cName | 姓名 |
cSex | 性别 |
cNation | 民族 |
cBirthday | 生日 |
cAddress | 地址 |
cId | 刷卡卡号 |
cIssuer | 发卡单位 |
cEffect | 身份证有效期 |
cExpire | 身份证失效时间 |
cDevInfo | 刷卡设备信息 |
cResult | 验证结果 |
cScore | 人脸得分 |
cOpenDoor | 是否已经开门， |
cDevCode | 设备标志 |
cDir | 出入方向 |
cReader | 读卡器标志 |
cDoor | 开门门号 |
cReason | 黑名单事由 |
cPhone | 联系电话 |
cMemo | 备注 |
访问地址 | record/getLog | |
参数定义 | 说明 | |
请求 | list | 要查询的日志的列表，每个元素为一个int值，指定一条记录（这个值是queryLog返回的一条 记录中cRecId） |
needCaptureImage | bool类型，是否需要取抓拍图片 | |
needIdImage | bool类型，是否需要取证件图片 | |
应答 | code | 返回码 |
message | 消息描述 | |
list | Json数组，日志记录列表。每个元素有如下信息 | |
应答返回的list列表中每个对象包含如下信息（和queryLog类似，多了证件图片和抓拍图片）
cNbr | 工号 |
cTime | 刷卡、脸时间 |
cName | 姓名 |
cSex | 性别 |
cNation | 民族 |
cBirthday | 生日 |
cAddress | 地址 |
cId | 刷卡卡号 |
cIssuer | 发卡单位 |
cEffect | 身份证有效期 |
cExpire | 身份证失效时间 |
cIdImage | 证件图像，BASE64编码 |
cDevInfo | 刷卡设备信息 |
cResult | 验证结果 |
cScore | 人脸得分 |
cOpenDoor | 是否已经开门， |
cDevCode | 设备标志 |
cDir | 出入方向 |
cReader | 读卡器标志 |
cDoor | 开门门号 |
cReason | 黑名单事由 |
cPhone | 联系电话 |
cMemo | 备注 |
cImage | 实时抓拍图像,BASE64编码 |
访问地址 | person/deleteLog | |
参数定义 | 说明 | |
请求 | list | Json数组，每个元素是一个int，指定要删除的记录的标志 |
应答 | list | Json数组，对应多条记录删除的返回结果 每个元素中包含 recId code message |
code | 返回码 | |
message | 消息描述 | |