日期 | 版本 | 描述 |
---|---|---|
2015-3-18 | v1.0 | 初稿 |
本文档是接入树维一卡通平台的考勤机接口文档,设备厂家可以通过终端设备直接接入或者通过前置机中转方式接入平台。
文本数据传输采用 UTF-8 编码。
数据传输采用 HTTP 1.1 及以上协议,协议格式如下所述。
URL: /v4/attendance/heartbeat/{deviceid} 请求方式: GET, POST
考勤设备心跳请求, 设备一般每 1 分钟发送一次心跳请求
请求参数
应答
{"sys_time": }
URL: /v4/attendance/uploadrecord/{deviceid} 请求方式: POST, PUT
考勤设备上传脱机流水, 每次上传的流水笔数不能超过 20 条
请求参数
请求头
请求报文的 Content-Type 必须为 text/plain
请求 body
上传流水数据, JSON encoded 格式,例子如下:
[ { "termdate": "20150418", "termtime": "134554", "devseqno": 10, "cardphyid": "DB3412FF" }, { "termdate": "20150418", "termtime": "140145", "devseqno": 11, "cardphyid": "55EF2B3C" } ]
应答
{"record_count": <record_count>}
URL: /v4/attendance/uploadrecordwithpic/{deviceid} 请求方式: POST, PUT
考勤设备上传脱机
请求参数
以上参数必须在 URL 中上传
请求头
请求报文的 Content-Type 必须为 application/octet-stream
请求 body
上传照片文件的内容,采用二进制流传输
应答
URL: /v4/attendance/onlinecheck/{deviceid} 请求方式: POST, PUT
考勤设备联机考勤
请求参数
应答
{"result": "failed", "message": "不在考勤时间段"}
返回参数定义
参数名 | 定义 |
---|---|
result | 考勤认证结果,ok 表示成功,failed 表示失败 |
message | 当卡认证失败时返回错误信息 |