ZKEco Pro API 集成
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_d700cf66/zkeco-pro-api。
技能介绍
要解决什么问题
企业把时间与安全业务跑在 ZKEco Pro 上时,HR、门禁、消费等数据往往要进自研系统或数据中台。官方开放平台(v10.0.1)有 24 个接口,但约定集中:全是 POST、JSON 体、URL 上 ?key=ACCESS_KEY 鉴权,且 没有 webhook,记录只能由你方 定时轮询。批量写入、查询时间窗、ret 与 error_list 若处理不当,很容易出现漏数、重复拉取或部分失败被当成成功。
技能如何帮你对接
本技能把对接要点压成可执行的「契约表」与模式说明,并指向 assets/ 里可复制的 Python(urllib) 与 Java 11 HttpClient 示例,内含 ZKEcoClient 封装、六大业务域方法,以及考勤/门禁/消费的 id 增量生成器(iter_transaction 等)。
- 基础路径:
http://{host}:{port}/api/v2/(默认端口 81) - 主数据:部门、人员(含离职/恢复、比对照、门禁权限组)、设备、职务、区域
- 记录拉取:考勤
transaction/get、门禁record/get、IC/ID 消费等,用自增 id 作游标,从last_id继续 - 返回处理:
ret=0读data.items;ret=2必须遍历error_list;字段类错误对照 100~171
需要某接口的完整参数表、响应字段与示例 JSON 时,按技能说明读取 references/ZKEcoPro_API对接梳理_校验版.md(优先)或初版概览文档。
边界与注意点
- 记录查询 时间跨度 ≤1 个月,单次条数考勤/门禁 ≤2000、消费类 ≤5000;写入批量 ≤200
- id 在各记录接口间独立,首次可从 0 拉全量,之后务必 持久化本地最大 id
- 人员照片经
enrollpic传 BASE64 JPG(≥640×480),面部检测失败为ret=-100 - 删除部门前须清空子部门与人员;集成侧需自行部署 1~5 分钟 级别的轮询调度
使用场景
- 自研薪酬系统需按固定间隔从 ZKEco Pro 拉取考勤 transaction,并用 id 游标避免重复与漏单
- 门禁事件要写入自有安防平台,需轮询 record/get 并按 pin、sn、时间窗过滤通行记录
- 上线前要把 ERP 部门与人员批量写入 ZKEco,调用 department/employee update 并处理 ret=2 的 error_list
- 财务对账要把 IC/ID 消费流水同步到内部系统,在单月时间窗内分页拉取消费类记录接口
适合人员
- 负责把 ZKEco 考勤数据对接进自研 HR/薪酬的后端工程师,需要落实鉴权与增量 id 持久化
- 实施熵基门禁项目的集成顾问,向客户交付时要核对批量上限、时间窗分片与轮询调度清单
- 企业 IT 管理员维护组织架构,需通过 API 同步部门、人员离职恢复及门禁权限组而非纯手工录入
- 用 Java 或 Python 编写对接程序的开发者,希望直接复用示例里的 ZKEcoClient 与记录类迭代器