1.2.1. 请求结构
1.2.1.1. 服务地址
https://api.dbs.zkclouds.com
1.2.1.2. 通信协议
smart-dbs API 的所有接口均通过 HTTPS 进行通信，提供高安全性的通信通道
1.2.1.3. 公共参数
公共参数是用于接口鉴权及标识租户的参数，如非特殊接口(如获取token、创建租户)，在每个接口都需要添加，且公共参数需要统一放到HTTP Header请求部中。
| 参数名 | 必填 | 类型 | 描述 |
|---|---|---|---|
| Timestamp | Y | Integer | 当前 UNIX 时间戳，可记录发起 API 请求的时间。例如 1529223702。注意：如果与服务器时间相差超过5分钟，会引起签名过期错误。 |
| Authorization | Y | String | 值为accessToken |
1.2.1.4. 字符编码
均使用UTF-8编码
1.2.2. 消息体
请求body消息体
{
"lang": "zh-cn",
"usr": "username",
"pwd": "password",
"payload": {
"curPage": 1,
"pageSize": 10,
"params": {
"param1": "val1",
"param2": "val2"
}
}
}
| 参数 | 必填 | 说明 |
|---|---|---|
| lang | Y | 语言，会根据此字段返回对应语言的message描述 |
| usr | Y | 租户集成账户信息，根据接口需要，大部分接口都必填，集成账号来自创建公司接口返回信息 |
| pwd | Y | 租户集成账户密码, 该参数值由明文密码(明文密码来自创建公司接口返回信息)与用户名组合字符串md5 32小写加密所得，根据接口需要, 大部分接口都必填 如明文密码为123,集成账号为test@zkteco,则该参数值为"123test@zkteco"加密后的值，即8f095251010f4ac576706aef61e5b2b1 |
| curPage | N | 当前页, 分页查询时需要 |
| pageSize | N | 分页大小，分页查询时需要 |
| params | N | 参数信息 |
返回body消息体
{
"code": "00000000",
"mid": "消息id,每个请求都会返回此字段，排查问题需提供此id",
"message": "success",
"payload": {
"totalRecords": 247,
"curPage": 1,
"totalPages": 25,
"pageSize": 10,
"results": {
}
}
}
| 参数 | 说明 |
|---|---|
| code | 错误编码,当且仅当code=00000000时表示消息处理成功 |
| mid | 消息id，每个请求回复都会返回此参数，用于排查问题 |
| totalRecords | 总记录数，分页查询时返回 |
| totalPages | 总分页数，分页查询时返回 |
| curPage | 当前页，分页查询时返回 |
| pageSize | 分页大小，分页查询时返回 |
| results | 返回结果数据 |
1.2.3. 接口鉴权
如下图所示，接入DBS API需注意以下几点:
根据appKey与appSecret获取accessToken，其他每次请求都必须带上accessToken；
当accessToken无效或过期时，第三方应用需重新获取accessToken；
