一脸通人脸考勤访客管理平台接口文档（API）

作者：admin 发布时间：2021-11-02

本API文档为第三方平台使用，智慧云天疫情防控一脸通考勤访客平台管理前端的人脸识别考勤、人脸识别测温以及健康码核验等等设备，人脸识别通行的记录数据保存在一脸通平台，第三方平台通过本文档对接一脸通平台，实现下发白名单、查询通行记录等等。请在对接时联系技术人员，获取测试参数及URL等。

一、开发前必读

1、错误码说明

错误码	说明
0	请求成功
500	业务错误（具体原因在msg中说明）

2、开始开发

在无特殊说明情况下，本平台http 接口数据交换格式为 Json，数据使用 UTF-8 编码。

二、接口列表

1、用户登陆接口

功能说明： 用于获取token,调用其他接口必须header中携带token。该值获取成功后时效为2小时，请自行维护token有效性。

请求URL：

http://192.168.0.11:9001/ent/api/login

请求方式：

POST

Header：

Content-Type:application/json

请求示例

{
	"username":"xxxxx",
	"password":"xxxxx"
}

参数说明：

参数名	必选	类型	说明
username	是	string	用户名
password	是	string	密码

返回示例

{
  "msg": "success",
  "code": 0,
  "expirat": "1629974276040",
  "token": "eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw",
  "username": "xxxxx"
}

返回说明：

参数名	必选	类型	说明
code	是	int	0：成功 500：失败
msg	是	string	请求结果说明
expirat	是	long	有效期截止时间戳，单位是毫秒。
username	是	string	当前登陆的用户名
token	是	string	token, 调用其他接口必须header中携带token

2、获取部门信息

功能说明：获取当前账号下的部门信息

请求URL：

http://192.168.0.10:9001/ent/rest/deptList

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

返回示例

{
    "msg": "success",
    "code": 0,
    "deptList": [
        {
            "deptId": "5",
            "type": "E",
            "deptCode": "0101",
            "name": "研发部",
            "parentId": "0",
            "parentName": null,
            "entId": 2
        },
        {
            "deptId": "6",
            "type": "E",
            "deptCode": "001",
            "name": "java后台开发",
            "parentId": "5",
            "parentName": "研发部",
            "entId": 2
        }
    ]
}

deptList中参数说明：

参数名	必选	类型	说明
deptId	是	string	部门ID
type	是	string	部门类型 (学校场景下: S:学生类型 E:职员类型)
name	是	string	部门名称
deptCode	是	string	部门编号
parentId	是	string	上级部门ID,一级部门值为 "0"
parentName	否	string	上级部门名称,一级部门值为空
entId	是	int	公司ID

3、根据部门ID获取部门信息

功能说明：获取当前账号下的部门信息

请求URL：

http://192.168.0.10:9001/ent/rest/findDeptById/{id}

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

返回示例

{
    "msg": "success",
    "code": 0,
    "dept": {
        "deptId": "9",
        "type": "E",
        "deptCode": "0202",
        "name": "光学部8",
        "parentId": "8",
        "parentName": "材料部$",
        "entId": 2
    }
}

返回参数说明：

参数名	必选	类型	说明
deptId	是	string	部门ID
type	是	string	部门类型 (学校场景下: S:学生类型 E:职员类型)
name	是	string	部门名称
deptCode	是	string	部门编号
parentId	是	string	上级部门ID,一级部门值为 "0"
parentName	否	string	上级部门名称,一级部门值为空
entId	是	int	公司ID

4、添加部门

功能说明：根据信息添加部门

请求URL：

http://192.168.0.10:9001/ent/rest/saveDept

请求方式：

POST

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
type	是	string	部门类型 (学校场景下: S:学生类型 E:职员类型)
name	是	string	部门名称
deptCode	是	string	部门编号
parentId	是	string	上级部门ID,一级部门值为 "0"
parentName	否	string	上级部门名称,一级部门值为空

请求参数示例

{
    "deptCode": "0204",
    "name": "电子元件部",
    "parentId": "8",
    "parentName": "材料部",
    "type": "E"
}

5、修改部门

功能说明：根据信息修改部门

请求URL：

http://192.168.0.10:9001/ent/rest/updateDept

请求方式：

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
deptId	是	String	部门ID
type	是	string	部门类型 (学校场景下: S:学生类型 E:职员类型)
name	是	string	部门名称
deptCode	是	string	部门编号
parentId	是	string	上级部门ID,一级部门值为 "0"
parentName	否	string	上级部门名称,一级部门值为空

请求参数示例

{
    "deptId": "8",
    "deptCode": "0201",
    "name": "材料部$",
    "parentId": "0",
    "parentName": null,
    "entId": 2
}

6、删除部门

功能说明：根据部门ID删除部门

请求URL：

http://192.168.0.10:9001/ent/rest/deleteDept

请求方式：

DELETD

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
deptId	是	String	部门ID

请求参数示例

"9,10"

7、获取设备列表

功能说明： 查询当前账号下绑定的设备记录

请求URL：

http://192.168.0.11:9001/ent/rest/devlist

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
limit	否	int	每页数量
page	否	int	第page页
sidx	否	string	排序字段(驼峰命名的字段改为下划线分隔，如设备名排序, 用device_name)
order	否	string	排序正序: asc 倒序 desc 默认是正序

返回示例

{
  "msg": "success",
  "code": 0,
  "page": {
    "totalCount": "32",
    "pageSize": 10,
    "totalPage": "4",
    "currPage": 1,
    "list": [
      {
        "id": 1,
        "deviceName": "测试机器",
        "deviceMac": "d2:64:71:01:65:89",
        "lastConnectTime": "2021-08-26 18:21:40",
        "online": true,
        "createUser": "xxx",
        "createTime": "2021-05-25 10:57:33",
        "versionNumber": "459",
        "ip": "49.83.209.29",
        "entId": 123,
        "entName": "企业二"
      },
      {
        "id": 2,
        "deviceName": "测温人脸机",
        "deviceMac": "ce:c7:57:7b:ee:90",
        "lastConnectTime": "2021-08-05 16:35:25",
        "online": false,
        "createUser": "xxx",
        "createTime": "2021-08-05 16:34:36",
        "versionNumber": "3018",
        "ip": "183.11.243.156",
        "entId": 223,
        "entName": "企业一"
      }
    ]
  }
}

返回内容说明：

参数名	必选	类型	说明
totalCount	是	int	记录总数量
pageSize	是	int	每页大小
totalPage	是	int	总页数
currPage	是	int	当前页
list	是	list	数据集合

list中参数说明：

参数名	必选	类型	说明
id	是	int	设备ID
deviceName	是	string	设备名称
deviceMac	是	string	设备MAC
lastConnectTime	否	date	上次心跳时间
online	是	boolean	在线状态
versionNumber	否	string	软件版本号
ip	否	string	设备公网IP
entId	是	int	设备所在企业ID
entName	是	string	企业名称
createUser	是	string	登记设备管理员名称
createTime	是	date	登记设备时间

8、根据设备ID获取设备信息

功能说明：获取当前账号下的设备信息

请求URL：

http://192.168.0.10:9001/ent/rest/findDevById/{id}

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

返回示例

{
    "msg": "success",
    "code": 0,
    "device": {
        "id": 12,
        "deviceName": "看门狗2",
        "deviceMac": "f2:32:57:94:6f:DC",
        "lastConnectTime": "2021-08-30 11:19:48",
        "createUser": "qycs",
        "createTime": "2021-08-31 11:19:48",
        "online": false,
        "versionNumber": "4231",
        "ip": "192.168.0.12",
        "entId": 2,
        "entName": null
    }
}

返回内容说明：

id	是	int	设备ID
deviceName	是	string	设备名称
deviceMac	是	string	设备MAC
lastConnectTime	否	date	上次心跳时间
online	是	boolean	在线状态
versionNumber	否	string	软件版本号
ip	否	string	设备公网IP
entId	是	int	设备所在企业ID
entName	否	string	企业名称
createUser	是	string	登记设备管理员名称
createTime	是	date	登记设备时间

9、保存设备

功能说明：根据信息保存设备

请求URL：

http://192.168.0.10:9001/ent/rest/saveDevice

请求方式：

POST

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
deviceName	是	String	设备名称
deviceReaderType	否	string	读头类型(1:无,2:IC读卡,3:身份证二合一)
deviceFunctionType	否	String	应用场景(0:员工专用,1:访客专用,2:员工访客通用,3:通用-人脸识别加比对)
deviceArea	是	String	安装区域 G:大门 D:部门 U:房间 (房间是校园场景)
deviceLocation	否	String	安装位置
deviceMac	是	String	设备MAC
deptId	否	int	部门ID
inoutType	否	String	出入类型 0:进 1:出

请求参数示例

{
    "deviceName": "镇门狮",
    "deviceReaderType": "1",
    "deviceFunctionType": "2",
    "deviceArea": "G",
    "deviceLocation": "殿下",
    "deviceMac": "f2:32:57:94:6f:ee",
    "deptId": 2,
    "inoutType": "0"
}

10、删除设备

功能说明：根据id数组删除设备

请求URL：

http://192.168.0.10:9001/ent/rest/deleteDevice

请求方式：

DELETE

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
ids	是	int	所删除设备id数组

请求参数示例

[10,11]

11、更改设备

功能说明：根据信息更改设备

请求URL：

http://192.168.0.10:9001/ent/rest/updateDevice

请求方式：

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
id	是	int	设备id
deviceName	是	String	设备名称
deviceReaderType	否	string	读头类型(1:无,2:IC读卡,3:身份证二合一)
deviceFunctionType	否	String	应用场景(0:员工专用,1:访客专用,2:员工访客通用,3:通用-人脸识别加比对)
deviceArea	否	String	安装区域 G:大门 D:部门 U:房间 (房间是校园场景)
deviceLocation	否	String	安装位置
deviceMac	是	String	设备MAC
deptId	否	int	部门ID
inoutType	否	String	出入类型 0:进 1:出

请求参数示例

{
    "id": 12,
    "deviceName": "镇门狮",
    "deviceReaderType": "1",
    "deviceFunctionType": "2",
    "deviceArea": "G",
    "deviceLocation": "殿下",
    "deviceMac": "f2:32:57:94:6f:ee",
    "deptId": 2,
    "inoutType": "0"
}

12、获取员工信息

功能说明：获取当前账号下的员工信息

请求URL：

http://192.168.0.11:9001/ent/rest/stafflist

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
limit	否	int	每页数量
page	否	int	第page页
sidx	否	string	排序字段(驼峰命名的字段改为下划线分隔，如设备名排序, 用device_name)
order	否	string	排序正序: asc 倒序 desc 默认是正序
staffName	否	String	员工姓名
staffCode	否	String	员工工号
staffMobile	否	String	员工手机号

返回示例

{
    "msg": "success",
    "code": 0,
    "page": {
        "totalCount": "2",
        "pageSize": 10,
        "totalPage": "1",
        "currPage": 1,
        "list": [
           {
                "id": 15,
                "staffName": "黄东东",
                "staffCode": "0518",
                "staffMobile": "15766895253",
                "satffIdcard": "362423199702062234",
                "staffSex": 1,
                "staffAddress": "深圳宝安官田",
                "deptId": 6,
                "deptName": " /研发部 /java后台开发",
                "entId": 2,
                "entName": "测试企业",
                "postId": 6,
                "postName": "java开发",
                "staffPhoto": "staff-images/sf_592204367352221696.jpg"
            },
            {
                "id": 14,
                "staffName": "戴胸",
                "staffCode": "0001",
                "staffMobile": "18888888888",
                "satffIdcard": null,
                "staffSex": 1,
                "staffAddress": null,
                "deptId": 7,
                "deptName": " /研发部 /安卓设备前端",
                "entId": 2,
                "entName": "测试企业",
                "postId": null,
                "postName": null,
                "staffPhoto": "staff-images/sf_590817061516726272.jpeg"
            }
        ]
    }
}

返回内容说明：

参数名	必选	类型	说明
totalCount	是	int	记录总数量
pageSize	是	int	每页大小
totalPage	是	int	总页数
currPage	是	int	当前页
list	是	list	数据集合

list中参数说明：

参数名	必选	类型	说明
id	是	int	员工ID
staffName	是	string	员工姓名
staffCode	是	string	工号
staffMobile	是	string	手机号
satffIdcard	是	boolean	身份证号
staffSex	是	string	员工性别(0-女,1-男,2-未知)
staffAddress	是	string	住址
entId	是	int	企业ID
entName	是	string	企业名称
deptId	是	int	部门ID
deptName	是	string	部门名称
postId	否	int	岗位id
postName	否	String	岗位名称
staffPhoto	否	String	用户头像

13、根据员工ID获取员工信息

功能说明：获取当前账号下的员工信息

请求URL：

http://192.168.0.10:9001/ent/rest/findStaffById/{id}

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

返回示例

{
    "msg": "success",
    "code": 0,
    "entStaff": {
        "id": 15,
        "staffName": "黄东东",
        "staffCode": "0518",
        "staffMobile": "15766895253",
        "satffIdcard": "362423199702062234",
        "staffSex": 1,
        "staffAddress": "深圳宝安官田",
        "deptId": 6,
        "deptName": null,
        "entId": 2,
        "entName": null,
        "postId": 6,
        "postName": null,
        "staffPhoto": null
    }
}

返回参数说明：

参数名	必选	类型	说明
id	是	int	员工ID
staffName	是	string	员工姓名
staffCode	是	string	工号
staffMobile	是	string	手机号
satffIdcard	是	boolean	身份证号
staffSex	是	string	员工性别(0-女,1-男,2-未知)
staffAddress	是	string	住址
entId	是	int	企业ID
entName	否	string	关联字段（不用管）
deptId	是	int	部门ID
deptName			关联字段（不用管）
postId	否	int	岗位id
postName			关联字段（不用管）
staffPhoto			关联字段（不用管）

14、添加员工

功能说明：根据信息添加员工

请求URL：

http://192.168.0.10:9001/ent/rest/saveDevice

请求方式：

POST

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
staffName	是	string	员工姓名
staffCode	是	string	工号
staffMobile	是	string	手机号
satffIdcard	是	boolean	身份证号
staffSex	是	string	员工性别(0-女,1-男,2-未知)
staffAddress	是	string	住址
deptId	是	int	部门ID
postId	否	int	岗位id

请求参数示例

{
    "deviceName": "门禁机04",
    "deviceCode": "9696",
    "deviceType": "W",
    "deviceSize": "2",
    "deviceReaderType": "1",
    "deviceFunctionType": "2",
    "deviceArea": "G",
    "deviceLocation": "殿下",
    "deviceMac": "f2:32:57:94:6f:c9",
    "versionNumber": "4231",
    "ip": "192.168.0.11",
    "deptId": 2,
    "faceMaskDetect": "T",
    "faceMaskVpt": "0.5",
    "tempOpenFlag": "T",
    "animalHeatVpt": "37.3",
    "inoutType": "0"
}

15、修改员工

功能说明：根据信息修改员工

请求URL：

http://192.168.0.10:9001/ent/rest/updateStaff

请求方式：

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
id	是	int	员工ID
staffName	是	String	员工姓名
staffCode	是	String	工号
staffMobile	是	String	手机号
satffIdcard	是	boolean	身份证号
staffSex	是	String	员工性别(0-女,1-男,2-未知)
staffAddress	是	String	住址
deptId	是	int	部门ID
postId	否	int	岗位id

请求参数示例

{   
    "id": 16,
    "staffName": "@开天@",
    "staffCode": "0011",
    "staffMobile": "15766899963",
    "satffIdcard": "362423199702065634",
    "staffSex": 0,
    "staffAddress": "深圳宝安石龙仔官田北环北",
    "deptId": 6,
    "postId": 6
}

16、删除员工

功能说明：根据信息保存设备

请求URL：

http://192.168.0.10:9001/ent/rest/deleteStaff

请求方式：

DELETE

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
ids	是	int	所删除设备id数组

请求参数示例

[16]

17、获取员工人脸信息

功能说明：获取当前账号下的员工人脸信息

请求URL：

http://192.168.0.11:9001/ent/rest/staffFaceList

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
limit	否	int	每页数量
page	否	int	第page页
sidx	否	string	排序字段(驼峰命名的字段改为下划线分隔，如设备名排序, 用device_name)
order	否	string	排序正序: asc 倒序 desc 默认是正序
staffName	否	String	员工姓名
staffCode	否	String	员工工号
staffMobile	否	String	员工手机号

返回示例

{
    "msg": "success",
    "code": 0,
    "page": {
        "totalCount": "2",
        "pageSize": 10,
        "totalPage": "1",
        "currPage": 1,
        "list": [
             {
                "id": 14,
                "staffId": 15,
                "facePath": "staff-images/sf_592204367352221696.data",
                "imgPath": "staff-images/sf_592204367352221696.jpg",
                "startValidity": "2021-08-30",
                "endValidity": "2024-08-30",
                "entId": 2,
                "deptId": 6
            },
            {
                "id": 13,
                "staffId": 14,
                "facePath": "staff-images/sf_590817061516726272.data",
                "imgPath": "staff-images/sf_590817061516726272.jpeg",
                "startValidity": "2021-08-26",
                "endValidity": "2022-08-26",
                "entId": 2,
                "deptId": 7
            }
        ]
    }
}

返回内容说明：

参数名	必选	类型	说明
totalCount	是	int	记录总数量
pageSize	是	int	每页大小
totalPage	是	int	总页数
currPage	是	int	当前页
list	是	list	数据集合

list中参数说明：

参数名	必选	类型	说明
id	是	int	员工人脸ID
staffId	是	int	员工ID
facePath	是	string	人脸特征文件路径
imgPath	是	string	人脸图片路径
startValidity	是	date	有效开始时间
endValidity	是	date	有效结束时间
entId	是	int	企业ID
deptId	否	int	部门ID

18、添加员工人脸信息

功能说明：根据信息添加员工人脸信息以及向相关设备推送人脸数据

请求URL：

http://192.168.0.10:9001/ent/rest/saveStaffFace

请求方式：

POST

参数类型：

form-data

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
staffId	是	string	员工ID
imageFile	是	string	员工人脸图片

19、根据人脸ID获取人脸信息

功能说明：获取当前账号下的员工人脸信息

请求URL：

http://192.168.0.10:9001/ent/rest/getStaffFaceById/{id}

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

返回示例

{
    "msg": "success",
    "code": 0,
    "entStaffFace": {
        "id": 13,
        "staffId": 14,
        "facePath": "staff-images/sf_590817061516726272.data",
        "imgPath": "staff-images/sf_590817061516726272.jpeg",
        "startValidity": "2021-08-26",
        "endValidity": "2024-08-26",
        "entId": 2,
        "deptId": null
    }
}

返回参数说明：

参数名	必选	类型	说明
id	是	int	员工人脸ID
staffId	是	int	员工ID
facePath	是	string	人脸特征文件路径
imgPath	是	string	人脸图片路径
startValidity	是	date	有效开始时间
endValidity	是	date	有效结束时间
entId	是	int	企业ID
deptId	否	int	部门ID

20、根据员工ID获取相应人脸信息

功能说明：获取当前账号下的员工人脸信息

请求URL：

http://192.168.0.10:9001/ent/rest/getOneStaffFace/{id}

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

返回示例

{
    "msg": "success",
    "face": {
        "id": 14,
        "staffId": 15,
        "facePath": "staff-images/sf_592204367352221696.data",
        "imgPath": "staff-images/sf_592204367352221696.jpg",
        "startValidity": "2021-08-30",
        "endValidity": "2024-08-30",
        "entId": 2,
        "deptId": null
    },
    "code": 0
}

返回参数说明：

参数名	必选	类型	说明
id	是	int	员工人脸ID
staffId	是	int	员工ID
facePath	是	string	人脸特征文件路径
imgPath	是	string	人脸图片路径
startValidity	是	date	有效开始时间
endValidity	是	date	有效结束时间
entId	是	int	企业ID
deptId	否	int	部门ID

21、人脸期限修改

功能说明：根据信息修改人脸信息，同时将修改推送到相关设备

请求URL：

http://192.168.0.10:9001/ent/rest/updateStaffFace

请求方式：

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
id	是	int	人脸ID
startValidity	是	Date	有效期起始时间
endValidity	是	Date	有效期结束时间

请求参数示例

{
    "id": 13,
    "startValidity": "2021-08-26",
    "endValidity": "2022-08-26"
}

22、人脸状态修改(禁用\启用)

功能说明：根据信息修改人脸信息，同时将修改推送到相关设备

请求URL：

http://192.168.0.10:9001/ent/rest/updateFaceStatus

请求方式：

参数类型：

JSON

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
id	是	int	人脸ID
faceStatus	是	Date	人脸状态 0：正常 1：禁用

请求参数示例

{
    "id": 13,
    "faceStatus": 1
}

23、人脸删除

功能说明：根据人脸ID删除人脸信息，同时将修改推送到相关设备

请求URL：

http://192.168.0.10:9001/ent/rest/updateFaceStatus

请求方式：

参数类型：

DELETE

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
id	是	int	人脸ID

请求参数示例

[16]

24、获取员工通行记录

（建议采用：员工通行记录实时推送接口）

功能说明：获取当前账号下的员工通行记录

请求URL：

http://192.168.0.10:9001/ent/rest/staffAccessList

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
limit	否	int	每页数量
page	否	int	第page页
sidx	否	string	排序字段(驼峰命名的字段改为下划线分隔，如设备名排序, 用device_name)
order	否	string	排序正序: asc 倒序 desc 默认是正序
staffName	否	String	员工姓名
staffCode	否	String	员工工号
deviceName	否	String	设备名称
startTime	否	String	开始时间范围
endTime	否	String	结束时间范围

返回示例

{
    "msg": "success",
    "code": 0,
    "page": {
        "totalCount": "162",
        "pageSize": 10,
        "totalPage": "17",
        "currPage": 1,
        "list": [
            {
                "id": 163,
                "entId": 2,
                "entName": "测试企业",
                "deviceId": 9,
                "deviceName": "门禁机02",
                "deviceMac": "f2:32:57:94:6f:2c",
                "deptId": 6,
                "deptName": "java后台开发",
                "staffId": null,
                "staffName": "黄**",
                "staffCode": "0518",
                "staffMobile": "157******53",
                "staffIdcard": "3624**********2234",
                "staffSex": 1,
                "staffCardNo": "0",
                "accessType": "F",
                "accessTime": "2021-08-30 14:25:21",
                "snapImgPath": "https://oss.zhytcloud.com/ylt/sa_acc/20210830/5cde488187bb450ba6181a350a91ca87.jpg",
                "animalHeat": "36.61",
                "similarity": 12,
                "inoutType": "0",
                "createTime": "2021-08-30 14:25:29"
            },
            {
                "id": 162,
                "entId": 2,
                "entName": "测试企业",
                "deviceId": 9,
                "deviceName": "门禁机02",
                "deviceMac": "f2:32:57:94:6f:2c",
                "deptId": 6,
                "deptName": "java后台开发",
                "staffId": 12,
                "staffName": "黄**",
                "staffCode": "0518",
                "staffMobile": "157******53",
                "staffIdcard": "3624**********2234",
                "staffSex": 1,
                "staffCardNo": "0",
                "accessType": "F",
                "accessTime": "2021-08-30 14:22:52",
                "snapImgPath": "https://oss.zhytcloud.com/ylt/sa_acc/20210830/0708f4e22c0949d892e2222ac08b02ed.jpg",
                "animalHeat": "36.39",
                "similarity": null,
                "inoutType": "0",
                "createTime": "2021-08-30 14:24:33"
            }
        ]
    }
}

返回内容说明：

参数名	必选	类型	说明
totalCount	是	int	记录总数量
pageSize	是	int	每页大小
totalPage	是	int	总页数
currPage	是	int	当前页
list	是	list	数据集合

list中参数说明：

id	是	int	通行记录ID
entId	是	int	企业ID
entName	是	string	企业名称
deviceId	是	string	设备ID
deviceName	是	string	设备名称
deviceMac	是	string	设备MAC
deptId	否	int	部门ID
deptName	否	string	部门名称
staffId	是	int	员工ID
staffName	是	string	员工姓名
staffCode	是	string	员工工号
staffMobile	是	string	员工手机号
staffIdcard	否	string	身份证
staffSex	否	int	性别：0：女；1：男
staffCardNo	否	string	员工卡号
accessType	是	string	开门类别 F:刷脸开门 S:刷卡开门 A:手机开门 M:密码开门 Z:身份证开门
accessTime	是	string	通行时间
snapImgPath	是	string	抓拍图片
animalHeat	否	string	体温
similarity	否	string	相识度
inoutType	是	string	进出 0：进 1出
createTime	是	string	创建时间

25、获取陌生人通行记录

（建议采用：陌生人实时推送接口）

功能说明：获取当前账号下的陌生人通行记录

请求URL：

http://192.168.0.10:9001/ent/rest/strangerList

请求方式：

Header：

token:eyJ0eXAixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxeSgXL1wf1g-P0b9MVTMw

参数说明：

参数名	必选	类型	说明
limit	否	int	每页数量
page	否	int	第page页
sidx	否	string	排序字段(驼峰命名的字段改为下划线分隔，如设备名排序, 用device_name)
order	否	string	排序正序: asc 倒序 desc 默认是正序
deviceName	否	String	设备名称
startTime	否	String	开始时间范围
endTime	否	String	结束时间范围

返回示例

{
    "msg": "success",
    "code": 0,
    "page": {
        "totalCount": "69",
        "pageSize": 10,
        "totalPage": "7",
        "currPage": 1,
        "list": [
            {
                "id": 121,
                "entId": 2,
                "deptId": 0,
                "jkmstatus": "",
                "jkmtype": "",
                "deviceMac": "f2:32:57:94:6f:2c",
                "accessImage": "https://oss.zhytcloud.com/ylt/msr-acc//20210830/b50b40b912b64ad4ab4d8908a2715a51.jpg",
                "createTime": "2021-08-30 14:07:03",
                "animalHeat": "36.05"
            }
        ]
    }
}

返回内容说明：

参数名	必选	类型	说明
totalCount	是	int	记录总数量
pageSize	是	int	每页大小
totalPage	是	int	总页数
currPage	是	int	当前页
list	是	list	数据集合

list中参数说明：

参数名	必选	类型	说明
id	是	int	ID
jkmstatus	否	string	健康码状态
jkmtype	否	string	健康码类型
deviceMac	是	string	设备MAC
accessImage	是	string	抓拍照
createTime	是	date	创建/ 通行时间
animalHeat	否	string	体温
entId	是	int	企业ID
deptId	否	int	部门ID

26、单点登录跳转到疫情防控可视化页面

功能说明：登陆

请求URL：

http://120.25.227.4:9001/ent/rest/web?token=xxxxx

请求方式：

一脸通人脸考勤访客管理平台接口文档（API）

一、开发前必读

1、错误码说明

2、开始开发

二、接口列表

1、用户登陆接口

2、获取部门信息

3、根据部门ID获取部门信息

4、添加部门

5、修改部门

6、删除部门

7、获取设备列表

8、根据设备ID获取设备信息

9、保存设备

10、删除设备

11、更改设备

12、获取员工信息

13、根据员工ID获取员工信息

14、添加员工

15、修改员工

16、删除员工

17、获取员工人脸信息

18、添加员工人脸信息

19、根据人脸ID获取人脸信息

20、根据员工ID获取相应人脸信息

21、人脸期限修改

22、人脸状态修改(禁用\启用)

23、人脸删除

24、获取员工通行记录

25、获取陌生人通行记录

26、单点登录跳转到疫情防控可视化页面

标签