1.3.1. 请求结构

1.3.1.1. 服务地址

  中国区： https://api.dbs.zkclouds.com

1.3.1.2. 通信协议

smart-dbs API 的所有接口均通过 HTTPS 进行通信，提供高安全性的通信通道。

1.3.1.3. 公共参数

公共参数是用于接口鉴权及标识租户的参数，如非特殊接口(如获取token、创建租户)，在每个接口都需要添加，且公共参数需要统一放到HTTP Header请求部中。

参数 类型 必填 描述
Timestamp Long Y 当前 UNIX 时间戳，精确到秒，可为记录发起 API 请求的时间。例如 1529223702。注意：如果与服务器时间相差超过5分钟，会引起签名过期错误。
Authorization String Y 值为accessToken，通过获取AccessToken接口获取 accessToken。

1.3.1.4. 字符编码

均使用UTF-8编码

1.3.1.5. 请求体大小

单接口请求体大小不超过1M

1.3.2. 消息体

请求body消息体

{
    "lang": "zh-cn",
    "usr": "username",
    "pwd": "password",
    "payload": {
        "curPage": 1,
        "pageSize": 10,
        "params": {
            "param1": "val1",
            "param2": "val2"
        }
    }
}
参数 类型 必填 说明
lang String Y 语言，会根据此字段返回对应语言的message描述;zh-cn代表中文，en代表英文
usr String Y 租户集成账户信息，根据接口需要，大部分接口都必填，集成账号来自创建公司接口返回信息
pwd String Y 租户集成账户密码, 该参数值由明文密码(明文密码来自创建公司接口返回信息)与用户名组合字符串md5 32小写加密所得，根据接口需要, 大部分接口都必填
如明文密码为123,集成账号为test@zkteco,则该参数值为"123test@zkteco"加密后的值，即8f095251010f4ac576706aef61e5b2b1
curPage Integer N 当前页, 分页查询时需要
pageSize Integer N 分页大小，分页查询时需要
params Object N 参数信息

返回body消息体

{
    "code": "00000000",
    "mid": "消息id,每个请求都会返回此字段，排查问题需提供此id",
    "message": "success",
    "payload": {
        "totalRecords": 247,
        "curPage": 1,
        "totalPages": 25,
        "pageSize": 10,
        "results": {

        }
    }
}
参数 类型 说明
code String 错误编码,当且仅当code=00000000时表示消息处理成功
mid String 消息id，每个请求回复都会返回此参数，用于排查问题
message String 请求返回描述信息，该描述仅供参考，具体错误以code为准
totalRecords Integer 总记录数，分页查询时返回
totalPages Integer 总分页数，分页查询时返回
curPage Integer 当前页，分页查询时返回
pageSize Integer 分页大小，分页查询时返回
results Object 返回结果数据

1.3.3. 接口鉴权

如下图所示，接入DBS API需注意以下几点:

  1. 根据appKey与appSecret获取accessToken，其他每次请求都必须带上accessToken；

  2. 当accessToken无效或过期时，第三方应用需重新获取accessToken；

avatar

results matching ""

    No results matching ""