API docsAPI docs
  • English
  • zh-CN
  • English
  • zh-CN
    • 概述
    • 请求 & 响应
    • 获取Auth Token
    • 使用 Auth Token
    • Api Example
    • 区域API
    • 部门API
    • 职位API
    • 人员API
    • 离职API
    • 设备API
    • 考勤记录API
    • 考勤报表API

请求 & 响应

请求

  • url地址
http://{host}:{port}
  • header参数

公共header参数是用于接口认证及标识用户的参数,如非特殊接口(如获取token),在每个接口都需要添加,且公共参数需要统一放到HTTP Header请求部中。

参数名必填类型描述
AuthorizationYString获取到的authToken
Content TypeYString固定值application/json
AcceptNString默认application/json
  • 查询参数
参数名必填类型描述
pageNInteger页码
page_sizeNInteger每页数据数量

响应

  • status code
  • status code < 400: 请求成功
  • 400 < status code < 500: 客户段请求错误,检查返回信息,修改后重新发送请求
  • 500 < status code: 服务器异常
Prev
概述