《“陇明公”平台终端数据接口规范V0.docx》由会员分享,可在线阅读,更多相关《“陇明公”平台终端数据接口规范V0.docx(9页珍藏版)》请在优知文库上搜索。
1、“陇明公”平台终端数据接口规范VI.O版本信息:VI.O文档日期:2020-12目录一、概述4二、目的及范围4三、术语定义及缩略语4四、数据包通讯规范44. 1通讯方式45. 2通讯数据包格式定义4五、数据包内容格式定义56. 1设备登录82355.2 获取白名单82455.3 上传考勤信息82865.4 获取特征信息84175.5上传包含勤照片及体温的考勤信息84485.6获取服务器时间6553295.7心跳包655359六、常见问题96.1 获取信息长度是用来做什么的,对接的流程是什么96.2 关于数字是怎么传输的9版本说明修订人修订版本描述修订时间修订内容蒋健vl.O2020/12一、概
2、述本终端数据接口规范主要是为考勤设备的供应商与“陇明公”平台进行数据交互对接时使用。本接口规范以“陇明公”平台数据标准为指导,明确定义了考勤设备数据与“陇明公”平台对接的流程规范以及数据接口规范,用以指导相关对接工作的执行。本文主要读者为相关厂商的技术人员。二、目的及范围制定本规范的目的是为了统一考勤设备与“陇明公”平台的对接标准;本规范定义了终端设备登陆、上传采集信息、获取白名单、获取人员特征信息、上传考勤信息,获取服务器时间、上传心跳信息等接口内容。三、术语定义及缩略语下列缩略词适用于本规范:缩写中文描述实名制模块“陇明公”平台实名制模块白名单允许通过考勤设备进行考勤的人员清单四、数据包通
3、讯规范4.1 通讯方式本系统通讯方式采用Se)Cket通讯方式。SoCket连接建立后,按照通讯包格式定义组合通讯包。通讯包的请求与响应格式保持一致。通讯失败:flag=1,COntent二用于卡机显示的错误提示,UTF-8编码。4.2 通讯数据包格式定义起始位置长度内容说明标记类型备注01开始标记leaderByteOxOl14长度LENJengthUint内容的长度54分包顺序索引5artIndexUintOxOO94分包总数5artCountUintOxOO131版本VersionByte默认0x03142命令CommandUshortOxlO1616会话标识SessionIDByte1
4、6通讯唯一标识,每一个tcp连接由设备随机生成32LEN内容ContentByteLEN数据包内容32+LEN1状杰FlagByteOxO为成功,0x01为失败33+LEN1结束标记ailByte0x01五、数据包内容格式定义5.1 设备登录823说明备通讯的其他命令必须在本命令执行成功后,才可以使用。Content位置名称字节数格式说明0-31厂家识别码32ASCII32位厂家识别码由腾晖提供,所有设备一样32-63设备的唯一标识码32ASCII每台设备的唯一标识64校验和1HEXXor校验运算5.2 获取白名单824说明Content:位置名称字节数格式说明0-31设备的唯一标识码32AS
5、CII每台设备的唯一标识32-38该设备最后获取数据时间7HEXBCD码,年占2字节,月、日、时、分、秒各占一个字节39校验和1HEXXor校验运算返回值:位置名称字节数格式说明0-3项目编号4HEX低位在前4-103项目名称100UTF-8用于机器显示用104-104+CL数据记录CL数据记录可以为多条记录,根据每条记录的第一个字节来判断每条记录的长度和格式105+CL-106+CL校验和1HEX重复追加的内容Content:Add位置名称字节数格式说明0增加或者删除标志1Hex0为新增用户,1为删除用户1-4工人编号4HEX刷卡成功上传时需要用到5-14工人姓名10UTF-815-32身份
6、证号码18ASCII33-62工作岗位30UTF-863-69最后培训时间7HEXBCD码,年占2字节,月、日、时、分、秒各占一个字节70-73特征信息长度(FL)4Hex固定值074-74+FL特征信息FLHEX人员特征信息,根据特长度74+FL-80+FL其他680+FL-81+FL备份1备份Content:Del位置名称字节数格式说明0增加或者删除标志1Hex0为新增用户,1为删除用户1-4工人编号4HEX刷卡成功上传时需要用到若第一个字节为1则格式使用Content=Del.若第一个字节为0,则格式使用Content=Add.该命令一个小时调用一次,设备必须记录每次获取特征信息成功的时
7、间。5.3 上传考勤信息828说明多条信息重复追加ContentContent:位置名称字节数格式说明0-3工人编号4HEX低位在前4-10刷卡时间7HEXBCD码,年占2字节,月、日、时、分、秒各占一个字节11刷卡模式1HEX1表示虹膜,6表示人脸12-15照片长度(PL)4HEX低位在前16-(PL+16-D照片信息PLIlEX考勤照片的字节数组LEN-I校验和1HEXXor校验运算5.4 获取特征信息841Content:位置名称字节数格式说明0-15验证票据16ASCII安全性验证(固定值:FACESOCKETACCESS)16-19项目编号4HEX项目ID20-20是否全量获取1HE
8、X1:是0:否21-21身份证个数1HEX最大10022-22+CL身份证列表CL身份证列表,最大限制100个23+CL-23+CL校验和1HEXXor校验运算重复追加身份证列表:位置名称字节数格式说明0-17身份证号码18ASCII身份证号码返回值:位置名称字节数格式说明0-1记录条数2HEX记录条数2-2+CL数据记录CL数据记录可以为多条记录2+CL校验和1HEXXor校验运算重复追加身人员数据记录:位置名称字节数格式说明0-9姓名10UTF-8姓名10-27身份证号码18ASCII身份证号码28民族1HEX代号29-30性别2ASCII1:男:0:女31-170身份证地址140UTF8
9、身份证地址171-186出生年月016ASCIIyyyyMMdd()187-246发证机关60UTF8发证机关247-310有效期64UTF8有效期311-314项目编号4HEX项目编号315-318班组编号4HEX班组编号319-322工种编号4HEX工种编号323-326采集照片长度(GL)4HEX采集照片长度326-(326+GL-1)采集照片GLHEX采集照片(326+GL)-(326+GL+3)身份证照片长度(PL)4HEX身份证照片长度(326+GL+4)-(316+GL+4+PL-1)身份证照片PLHEX身份证照片(326+GL+4+PL)-(326+GL+4+PL+3)红外照片
10、长度(HL)4HEX红外照片长度(326+GL+4+PL+4)-(326+GL+4+PL+4+HL-l)红外照片HLHEX红外照片5.5上传包含勤照片及体温的考勤信息844说明多条信息重复追加ContentContent:位置名称字节数格式说明0-3工人编号4HEX低位在前4-10刷卡时间7HEXBCD码,年占2字节,月、日、时、分、秒各占一个字节11-11刷卡模式1HEX1表示虹膜,6表示人脸12-15照片长度(PL)4HEX低位在前16-16+PL照片信息PLHEX考勤照片的字节数组16+PL-26+PLIng10ASCII百度地图经度26+PL-36+PLIat10ASCII百度地图维度
11、36+PL-40+PL体温4ASCII例如36.741+PL-41+标识1HEX是否高温(I=高温,O=正常)PL42+PL-42+PL校险和1HEXXor校验运算5.6 获取服务器时间65532Content空返回值内容服务端以yyyyMMddhhmmss为格式返回字符串5.7 心跳包65535Content空返回值空六、常见问题6.1 获取信息长度是用来做什么的,对接的流程是什么上传考勤数据的流程:823824841828,用824获取人员白名单,再用841获取人员特征信息6.2 关于数字是怎么传输的关于数字,一个字节8位,即每个一字节最长存放255,照片长度是4个字节255=255,0,0,0256=0,1,0,0257=1,1,0,0823=73,3,0,0