14. 同步API
API列表
| 编号 | API名称 | 路径 | 版本 |
|---|---|---|---|
| 14.1 | 同步接口 | /open/sync/trigger | 1.0 |
| 14.2 | 租户、租户成员同步门禁接口 | /open/sync/sync/door/auth | 1.0 |
| 14.3 | 租户、租户成员门禁授权导入 | /open/sync/door/auth/import | 1.0 |
API调用
14.1: 同步接口
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/open/sync/trigger
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| dataArea | BODY | INTEGER | 是 | 数据分类编码 |
| beginModifyTimestamp | BODY | STRING | 否 | 需要查询的数据的时间戳范围，格式为：yyyy-MM-dd HH:mm:ss |
| endModifyTimestamp | BODY | STRING | 否 | 需要查询的数据的时间戳范围，格式为：yyyy-MM-dd HH:mm:ss |
| isFull | BODY | INTEGER | 是 | 是否全量同步,0增量，1全量 |
请求Body描述(非Form表单数据)
{
"dataArea": 1,
"beginModifyTimestamp": "",
"endModifyTimestamp": "",
"isFull": 1
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
14.2: 租户、租户成员同步门禁接口
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/open/sync/sync/door/auth
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| projectId | body | String | 是 | 项目ID |
| syncType | body | Integer | 是 | 同步类型1：自动授权，2手动授权，3自动+手动授权 |
请求Body描述(非Form表单数据)
{
"projectId": "21291201",
"syncType": 2
}
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
14.3: 租户、租户成员门禁授权导入接口
描述
请求信息
HTTP协议：HTTP,HTTPS
uri：/open/sync/door/auth/import
方法：POST
请求参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| file | param | file | 是 | 导入csv模板 |
返回信息
返回参数类型
JSON
返回参数
| 名称 | 位置 | 类型 | 必填 | 描述 |
|---|---|---|---|---|
| code | 顶层 | STRING | 是 | 响应码标识 |
| message | 顶层 | STRING | 是 | 响应消息文本 |
| data | 顶层 | JSONObject | 是 | 响应数据对象 |
返回结果示例
{
"code": "200",
"message": "success",
"data": {
}
}
异常返回示例
{"code":"1401","message":""}