请求地址

/api/token

请求方法

POST

备注

每个Token服务器保留48小时，过期服务器返回802，x-access-token为空

accessNo

Y

varchar(32)

第三方接入平台身份识别码

projAcessNo

Y

varchar(32)

项目接入编号

projKey

Y

varchar(32)

项目接入密钥

responeCode

Y

响应Code

200为成功，其它为失败，失败原因具体可看responeMessage

responeMessage

Y

响应Message

responseResult

Y

响应Result

得到获取的Token

请求地址

/api/team/create

请求方法

PUT

备注

name

Y

varchar(32)

班组名称

workType

Y

varchar(32)

班组类型

leaderAppointment

Y

varchar(32)

班组长证明书

leaderIdcard

Y

varchar(18)

工人身份证号

DES加密

leaderName

Y

varchar(24)

工人姓名

leaderSex

Y

tinyint(1)

性别

1：男 2：女

leaderNation

Y

varchar(32)

民族

leaderBirthday

Y

varchar(10)

生日

格式：yyyy-MM-dd

leaderAddress

Y

varchar(256)

住址

leaderSignOrgan

Y

varchar(256)

签发机关

leaderExpiryStart

Y

varchar(10)

有效期开始日期

格式：yyyy-MM-dd

leaderExpiryEnd

Y

varchar(10)

有效期结束日期

格式：yyyy-MM-dd

leaderHeadImg

Y

varchar(256)

身份证头像URL

leaderIdcardFront

Y

varchar(256)

身份证正面照URL

leaderIdcardBack

Y

varchar(256)

身份证反面照URL

leaderCurrentAddress

Y

varchar(256)

常住地址

leaderPolitical

Y

tinyint(1)

政治面貌

1：党员 2：团员 3：群众

leaderEducation

Y

tinyint(1)

文化程度

1：本科及以上 2：大专 3：中专 4：高中 5：初中 6：小学及以下

leaderPhone

Y

varchar(11)

手机号

DES加密

leaderContractCode

Y

varchar(256)

合同编号

leaderContractFile

Y

varchar(256)

合同附件URL

leaderCardNum

Y

varchar(256)

工资卡账号

DES加密

leaderCardBank

Y

varchar(10)

工资卡开户行代码

参照银行字典

leaderWorkType

Y

varchar(10)

工种代码

参照职位字典

leaderSecurityCode

Y

varchar(18)

社保号

DES加密

leaderSafetyEdu

Y

tinyint(1)

是否参加安全教育

1：参加 2：未参加

leaderSafetyEduImg

N

安全教育图片URL

参加了安全培训则为必须

leaderDoDate

Y

进场日期

格式：yyyy-MM-dd

responeCode

Y

响应Code

200为成功，其它为失败，失败原因具体可看responeMessage

responeMessage

Y

响应Message

responseResult

Y

响应Result

得到teamId，修改时必须使用到

请求地址

/api/team/update/{teamId}

请求方法

PUT

备注

name

Y

varchar(32)

班组名称

workType

Y

varchar(32)

班组类型

leaderAppointment

Y

varchar(32)

班组长证明书

leaderIdcard

Y

varchar(18)

工人身份证号

DES加密

leaderName

Y

varchar(24)

工人姓名

leaderSex

Y

tinyint(1)

性别

1：男 2：女

leaderNation

Y

varchar(32)

民族

leaderBirthday

Y

varchar(10)

生日

格式：yyyy-MM-dd

leaderAddress

Y

varchar(256)

住址

leaderSignOrgan

Y

varchar(256)

签发机关

leaderExpiryStart

Y

varchar(10)

有效期开始日期

格式：yyyy-MM-dd

leaderExpiryEnd

Y

varchar(10)

有效期结束日期

格式：yyyy-MM-dd

leaderHeadImg

Y

varchar(256)

身份证头像URL

leaderIdcardFront

Y

varchar(256)

身份证正面照URL

leaderIdcardBack

Y

varchar(256)

身份证反面照URL

leaderCurrentAddress

Y

varchar(256)

常住地址

leaderPolitical

Y

tinyint(1)

政治面貌

1：党员 2：团员 3：群众

leaderEducation

Y

tinyint(1)

文化程度

1：本科及以上 2：大专 3：中专 4：高中 5：初中 6：小学及以下

leaderPhone

Y

varchar(11)

手机号

DES加密

leaderContractCode

Y

varchar(256)

合同编号

leaderContractFile

Y

varchar(256)

合同附件URL

leaderCardNum

Y

varchar(256)

工资卡账号

DES加密

leaderCardBank

Y

varchar(10)

工资卡开户行代码

参照银行字典

leaderWorkType

Y

varchar(10)

工种代码

参照职位字典

leaderSecurityCode

Y

varchar(18)

社保号

DES加密

leaderSafetyEdu

Y

tinyint(1)

是否参加安全教育

1：参加 2：未参加

leaderSafetyEduImg

N

varchar(256)

安全教育图片URL

参加了安全培训则为必须

leaderDoDate

Y

varchar(10)

进场日期

格式：yyyy-MM-dd

responeCode

Y

响应Code

200为成功，其它为失败，失败原因具体可看responeMessage

responeMessage

Y

响应Message

responseResult

Y

响应Result

请求地址

/api/per/create

请求方法

PUT

备注

teamId

N

varchar(60)

班组ID

人员工种代码为管理人员时无需填写，为工人时必须填写

idcard

Y

varchar(18)

工人身份证号

DES加密

name

Y

varchar(24)

工人姓名

sex

Y

tinyint(1)

性别

1：男 2：女

nation

Y

varchar(32)

民族

birthday

Y

varchar(10)

生日

格式：yyyy-MM-dd

address

Y

varchar(256)

住址

signOrgan

Y

varchar(256)

签发机关

expiryStart

Y

varchar(10)

有效期开始日期

格式：yyyy-MM-dd

expiryEnd

Y

varchar(10)

有效期结束日期

格式：yyyy-MM-dd

headImg

Y

varchar(256)

身份证头像URL

idcardFront

Y

varchar(256)

身份证正面照URL

idcardBack

Y

varchar(256)

身份证反面照URL

currentAddress

Y

varchar(256)

常住地址

political

Y

tinyint(1)

政治面貌

1：党员 2：团员 3：群众

education

Y

tinyint(1)

文化程度

1：本科及以上 2：大专 3：中专 4：高中 5：初中 6：小学及以下

phone

Y

varchar(11)

手机号

DES加密

contractCode

Y

varchar(256)

合同编号

contractFile

Y

varchar(256)

合同附件URL

cardNum

Y

varchar(256)

工资卡账号

DES加密

cardBank

Y

varchar(10)

工资卡开户行代码

参照银行字典

workType

Y

varchar(10)

工种代码

参照职位字典

securityCode

Y

varchar(18)

社保号

DES加密

safetyEdu

Y

tinyint(1)

是否参加安全教育

1：参加 2：未参加

safetyEduImg

N

varchar(256)

安全教育图片URL

参加了安全培训则为必须

doDate

Y

varchar(10)

进场日期

格式：yyyy-MM-dd

responeCode

Y

响应Code

200为成功，其它为失败，失败原因具体可看responeMessage

responeMessage

Y

响应Message

responseResult

Y

响应Result

得到perId，修改时必须使用到

请求地址

/api/per/update/{perId}

请求方法

PUT

备注

teamId

N

varchar(60)

班组ID

人员工种代码为管理人员时无需填写，为工人时必须填写

idcard

Y

varchar(18)

工人身份证号

DES加密

name

Y

varchar(24)

工人姓名

sex

Y

tinyint(1)

性别

1：男 2：女

nation

Y

varchar(32)

民族

birthday

Y

varchar(10)

生日

格式：yyyy-MM-dd

address

Y

varchar(256)

住址

signOrgan

Y

varchar(256)

签发机关

expiryStart

Y

varchar(10)

有效期开始日期

格式：yyyy-MM-dd

expiryEnd

Y

varchar(10)

有效期结束日期

格式：yyyy-MM-dd

headImg

Y

varchar(256)

身份证头像URL

idcardFront

Y

varchar(256)

身份证正面照URL

idcardBack

Y

varchar(256)

身份证反面照URL

currentAddress

Y

varchar(256)

常住地址

political

Y

tinyint(1)

政治面貌

1：党员 2：团员 3：群众

education

Y

tinyint(1)

文化程度

1：本科及以上 2：大专 3：中专 4：高中 5：初中 6：小学及以下

phone

Y

varchar(11)

手机号

DES加密

contractCode

Y

varchar(256)

合同编号

contractFile

Y

varchar(256)

合同附件URL

cardNum

Y

varchar(256)

工资卡账号

DES加密

cardBank

Y

varchar(10)

工资卡开户行代码

参照银行字典

workType

Y

varchar(10)

工种代码

参照职位字典

securityCode

Y

varchar(18)

社保号

DES加密

safetyEdu

Y

tinyint(1)

是否参加安全教育

1：参加 2：未参加

safetyEduImg

N

varchar(256)

安全教育图片URL

参加了安全培训则为必须

doDate

Y

varchar(10)

进场日期

格式：yyyy-MM-dd

responeCode

Y

响应Code

200为成功，其它为失败，失败原因具体可看responeMessage

responeMessage

Y

响应Message

responseResult

Y

响应Result

请求地址

/api/per/status

请求方法

POST

备注

perId

Y

varchar(60)

第三方接入平台身份识别码

status

Y

varchar(32)

项目接入编号

responeCode

Y

响应Code

200为成功，其它为失败，失败原因具体可看responeMessage

responeMessage

Y

响应Message

responseResult

Y

响应Result

请求地址

/api/dev/create

请求方法

POST

备注

deviceKey

Y

varchar(9)

9位设备序列号代码

type

Y

tinyint(1)

类型

1：进门 2：出门

channel

Y

tinyint(1)

匝道

1：1匝道 2：2匝道 3：3匝道 4：4匝道 5：5匝道

responeCode

Y

响应Code

200为成功，其它为失败，失败原因具体可看responeMessage

responeMessage

Y

响应Message

responseResult

Y

响应Result

得到devId，解绑时必须使用到

请求地址

/api/dev/delete/{devId}

请求方法

DELETE

备注

无

responeCode

Y

响应Code

200为成功，其它为失败，失败原因具体可看responeMessage

responeMessage

Y

响应Message

responseResult

Y

响应Result

端口:

终端作为服务器端口为32068；

连接方向

终端主动连接PC，或者PC主动连接终端

数据包
基本格式：

包标识、包序号、包类型、数据长度、数据内容共五个字段
各字段描述如下：
包标识：包头标识（2字节，固定为0x8888）
包序号：包序列号（2字节，值域0-65535），不强制从0开始，但响应包必须与对应的请求包的包序号相同
包类型：请求或响应命令（1字节），详见下表描述。
子类型：命令对应的数据类型（1字节）详见下表描述。
数据长度：包数据内容长度，不包括本字段及前面各字段（单位：4字节）
数据内容：请求或响应数据的内容（当数据长度为0时本字段不存在），具体格式依不同包类型不同，详见各种包类型描述与子类型描述。

关于包类型与子类型取值说明

包类型

包类型取值

AUTH

0

认证,连接

GET

1

GET_NEXT

2

PUT

3

PUT_NEXT

4

RESPONSE

5

应答

TRAP

6

终端数据自动上报

HEARTBEAT

7

心跳

子类型

子类型取值

AUTH_RANDOM

0

AUTH_AUTHENTICATE

1

USER_ENROLL_FACE

65

USER_MANAGE_USER_ADMIN

108

USER_SEND_USER_ADMIN_TMPL

63

TRAP_VERIFY_RESULT

90

系统设置之建立连接，包括：终端主动连接PC、PC主动连接终端

AUTH

AUTH_RANDOM

AUTH_AUTHENTICATE

终端作为客户端：
1、TCP/IP连接建立后，客户端发起认证申请获取认证随机数
包类型：AUTH
子类型：AUTH_RANDOM
数据长度：52 字节
数据：协议版本号（2）+ 终端类型（2）+ 终端名称（16）+ 终端型号（16）+ 序列号（16）
2、服务器端收到此认证请求后，返回认证随机数
包类型：RESPONSE
子类型：ACK
数据长度：4字节
数据：随机数，由终端SN生成（4字节二进制数）
3、客户端收到认证随机数后，发送认证请求：
包类型：AUTH
子类型：AUTH_AUTHENTICATE
数据长度：16字节
数据： 16字节MD5校验码（由终端默认密码"f1i2r3s4F%I^R&S*" + 序列号(不足16位需要补零) + 随机数（低字节在前，高字节在后） 生成）
4、服务器收到认证请求后进行认证，如果认证成功返回：
包类型：RESPONSE
子类型：成功为ACK，失败为NAK
数据长度：0
数据：0
//#define ACK  0  /* 请求成功 */
#define NAK  1  /* 请求失败 *

AUTH_RANDOM

AUTH_AUTHENTICATE

终端作为服务端：
1、TCP/IP连接建立后，客户端发起认证申请获取认证随机数
包类型：AUTH
子类型：AUTH_RANDOM
数据长度：0
2、服务器收到认证请求后，返回认证随机数
包类型：RESPONSE
子类型：ACK
数据长度：4字节
数据：随机数，由终端SN生成（4字节二进制数）
3、客户端收到认证随机数后，发送认证请求：
包类型：AUTH
子类型：AUTH_AUTHENTICATE
数据长度：用户名（16字节）+MD5校验码（16字节）
数据： 16字节用户名（用户名为“admin”）+ 16字节MD5校验码（密码（设备端admin用户密码，默认"88888888"，不需要补0）+随机数生成(低位在前，高位在后)）
4、服务器收到认证请求后进行认证，如果认证成功返回：
包类型：RESPONSE
子类型：成功为ACK，失败为NAK
数据长度：52字节
数据：协议版本号（2）+ 终端类型（2）+ 终端名称（16）+ 终端型号（16）+ 序列号（16）

返回人脸注册信息

PUT

USER_ENROLL_FACE

A． 客户端发送用户注册请求：
包类型：PUT
子类型：USER_ENROLL_FACE
数据长度：用户工号长度（4字节） + 保存用户标识（1字节）+用户类型(1字节)
数据：用户工号（4字节，为0表示注册新用户） + 保存用户标识（0：只上传用户信息但终端不保存用户，1：保存并上传用户信息）
B． 终端收到有效的用户注册请求后响应：
包类型：RESPONSE
子类型：ACK
长度：用户注册响应数据结构长度
数据：用户注册响应数据结构，包含用户工号 + 用户特征码长度 + 用户特征码（二进制加密数据，与提取用户特征码方式得到的特征码一致） + 图片类型+用户照片长度+用户照片数据 + 卡号
备注：请求的用户工号或保存用户标识无效时返回NAK

用户注册响应数据结构：
字段名称    长度 备注
用户工号    4字节 用户工号
特征码长度  4字节 用户特征码长度
特征码 特征码长度 用户特征码数据
照片类型    1字节 0-BMP；1-JPG
照片长度    4字节 照片的长度，0为无照片
照片数据 照片长度 数据长度由照片长度决定（照片长度为0时本字段不存在）
卡号        4字节 用户卡号

添加人员

PUT

USER_MANAGE_USER_ADMIN

1、客户端发起请求：
包类型：PUT
子类型：USER_MANAGE_USER_ADMIN
数据长度：添加或修改用户信息时为用户信息记录长度，删除用户时长度等于5（1字节用户类型+4字节用户工号）
数据：添加或修改用户信息时为用户信息，删除用户时为用户工号，工号等于0时删除全部用户
2、终端响应：
包类型：RESPONSE
子类型：成功为ACK，失败为NAK
数据长度：0
数据：无

用户信息记录格式定义如下：
字段名称 长度 备注
用户类别 1字节 （0-普通用户，1-管理员，2-超级管理员）
用户工号 4字节
用户卡号 32字节
开门权限 4字节
用户名   32字节
部门编号 4字节
用户识别模式 1字节 （
1-人脸识别，
2-人脸或刷卡，
3-人脸与刷卡，
4-人脸与密码
5-人脸与工号 6-密码 7-刷卡 8-人脸或密码 9-刷卡+密码）
（普通用户：使用1，2，3，5，6, 7模式；
管理员：使用3，4模式）
注册状态 1字节 0-未注册人脸特征，1-已注册人脸特征
照片类型 1字节，固定为0
照片长度 4字节 照片的长度，0为无照片
照片数据 照片长度 数据长度由照片长度决定（照片长度为0时本字段不存在）

下发用户人脸特征文件

PUT

USER_SEND_USER_ADMIN_TMPL

1、 客户端发起请求：
包类型：PUT
子类型：USER_SEND_USER_ADMIN_TMPL
数据长度：用户工号（4字节）+用户类型(1字节) + 用户特征码数据长度
数据：用户工号（4字节） +用户类型(1字节) + 用户特征码数据（二进制加密数据，通过提取用户特征码方式得到）
2、终端收到有效的修改用户特征码信息请求后响应：
包类型：RESPONSE
子类型：ACK
长度：0
数据：无
备注：用户工号或特征码数据无效时返回NAK

上报识别结果

TRAP

TRAP_VERIFY_RESULT

1、系统连接后，终端识别通过或失败将自动给系统发送识别结果通知。
识别结果通知信息格式为：
包类型：TRAP
子类型：TRAP_VERIFY_RESULT
数据长度：用户工号（4字节）+ 用户识别结果（1字节）+ 相似度（1字节）+ 照片类型（1字节 0-BMP,1-JPG）+抓拍照片长度（JPG文件长度）
数据：用户工号（4字节二进制整数）+ 用户识别结果（1-识别成功；0-识别失败 ）+ 相似度（0-100）+ 照片类型（1字节 0-BMP,1-JPG）+照片长度+抓拍照片数据（JPG文件格式）
备注：系统请求识别只发送请求响应（已包含此通知信息），不再额外发送此TRAP通知
2、服务器应答：
包类型：RESPONSE
子类型：ACK
数据长度：0
数据：0
备注：失败返回NAK。

杂工

Z10

建筑起重机械司机

Z30

建筑架子工

Z40

砌筑工（建筑瓦工、瓦工）

010

窑炉修筑工

011

钢筋工

020

架子工（普通架子工）

030

附着升降脚手架安装拆卸工

031

高处作业吊篮操作工

032

高处作业吊篮安装拆卸工

033

混凝土工

040

模板工（混凝土模板工）

050

机械设备安装工

060

通风工

070

起重工（安装起重工）

080

安装钳工

090

电气设备安装工（电气安装调试工）

100

管工（管道工）

110

变电安装工

120

电工

130

弱电工

131

司泵工

140

挖掘铲运和桩工机械司机

150

推土机司机

151

铲运机司机

152

土石方挖掘机司机

153

打桩工

154

桩机操作工

160

起重信号工（起重信号司索工）

170

建筑起重机械安装拆卸工

180

装饰装修工

190

抹灰工

191

油漆工

192

镶贴工

193

涂裱工

194

装饰装修木工

195

室内成套设施安装工

200

建筑门窗幕墙安装工

210

幕墙安装工

211

建筑门窗安装工

212

幕墙制作工

220

防水工

230

木工

240

手工木工

241

精细木工

242

石工（石作业工）

250

焊工（电焊工）

270

爆破工

280

除尘工

290

测量放线工（测量工）

300

线路架设工

310

古建筑传统木工（木雕工、匾额工）

320

古建筑传统瓦工（砧刻工、砌花街工、泥塑工）

330

古建筑传统石工（石雕工、砧细工）

340

古建筑传统彩画工（彩绘工）

350

古建筑传统油工（推光漆工）

360

施工员

100

监理员

101

质检员

102

安全员

103

材料员

104

试验员

105

测量员

106

资料员

107