code值规则：

0，成功

1、未登录

3、通用错误

2、无权限

1. 用户模块

1.1. 登录

接口地址:/user/member/login

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{ "password": "123477", "rememberMe": false, "username": "111" }

请求参数:

请求参数:

参数名称参数说明in是否必须数据类型schemaloginloginbodytrueLoginMemberLoginMember  password密码falsestring  rememberMefalseboolean  username账号falsestring

响应状态:

状态码说明schema200OKR201Created401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装objectmsg返回值提示信息string

响应示例:

{ "code": 0, "content": {}, "msg": "" }

1.2. 退出登录

接口地址:/user/member/logout

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

请求参数:

暂无

响应状态:

状态码说明schema200OKR«string»401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装stringmsg返回值提示信息string

响应示例:

{ "code": 0, "content": "", "msg": "" }

2. 设备

2.1. 查询设备列表

接口地址:/device/lock/list

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

请求参数:

参数名称参数说明in是否必须数据类型schemaarea区域queryfalsestringcheckedStates状态queryfalsearrayintegername名称queryfalsestringsTimesTimequeryfalsearraystringtype类型queryfalseinteger(int32)

响应状态:

状态码说明schema200OKR401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装objectmsg返回值提示信息string

响应示例:

{ "code": 0, "content": {}, "msg": "" }

2.2. 设备详情

接口地址:/device/lock/{id}

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

请求参数:

参数名称参数说明in是否必须数据类型schemaididpathtrueinteger(int64)

响应状态:

状态码说明schema200OKR401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装objectmsg返回值提示信息string

响应示例:

{ "code": 0, "content": {}, "msg": "" }

2.3. 查询设备锁分页列表

接口地址:/device/lock/adminPage

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

请求参数:

参数名称参数说明in是否必须数据类型schemaaddress位置queryfalsestring

响应状态:

状态码说明schema200OKR«IPage«Map«string,object»»»401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装IPage«Map«string,object»»IPage«Map«string,object»»  currentinteger(int64)  pagesinteger(int64)  recordsarrayMap«string,object»  sizeinteger(int64)  totalinteger(int64)msg返回值提示信息string

响应示例:

{ "code": 0, "content": { "current": 0, "pages": 0, "records": [ {} ], "size": 0, "total": 0 }, "msg": "" }

3. 钥匙

3.1. 查询分页列表

接口地址:/key/keyInfo

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

请求参数:

参数名称参数说明in是否必须数据类型schemacurrent当前页queryfalseinteger(int32)pagingqueryfalsebooleansize每页显示条数queryfalseinteger(int32)

响应状态:

状态码说明schema200OKR401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装objectmsg返回值提示信息string

响应示例:

{ "code": 0, "content": {}, "msg": "" }

4. 开锁记录

4.1. 开锁记录上传

接口地址:/key/keyLog

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{ "keyId": 0, "lockId": 0, "unlockTime": "" }

请求参数:

请求参数:

参数名称参数说明in是否必须数据类型schemakeyLog钥匙日志bodytrueKeyLog对象KeyLog对象  keyId钥匙idfalseinteger(int64)  lockId锁idfalseinteger(int64)  unlockTime记录时间falsestring(date-time)

响应状态:

状态码说明schema200OKR«string»201Created401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装stringmsg返回值提示信息string

响应示例:

{ "code": 0, "content": "", "msg": "" }

4.2. 以设备id分页查询开锁记录

接口地址:/key/keyLog/logsWithKey

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

请求参数:

参数名称参数说明in是否必须数据类型schemacurrent当前页queryfalseinteger(int32)lockIdlockIdqueryfalseinteger(int64)pagingqueryfalsebooleansize每页显示条数queryfalseinteger(int32)

响应状态:

状态码说明schema200OKR401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装objectmsg返回值提示信息string

响应示例:

{ "code": 0, "content": {}, "msg": "" }

5. 授权

5.1. 给设备初始化完成

接口地址:/key/keyDeviceAuth

请求方式:PUT

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求参数:

请求参数:

参数名称参数说明in是否必须数据类型schemadeviceIddeviceIdquerytrueinteger(int64)lockOrderlockOrderquerytrueinteger(int32)

响应状态:

状态码说明schema200OKR201Created401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装objectmsg返回值提示信息string

响应示例:

{ "code": 0, "content": {}, "msg": "" }

5.2. 新增授权开锁

接口地址:/key/keyDeviceAuth

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*

接口描述:

请求示例:

{ "deviceId": 0, "endTime": "", "keyId": 0, "startTime": "" }

请求参数:

请求参数:

参数名称参数说明in是否必须数据类型schemakAuthkAuthbodytrueKAuthKAuth  deviceId设备idfalseinteger(int64)  endTime授权到期时间falsestring(date-time)  keyId钥匙idfalseinteger(int64)  startTime授权开始时间falsestring(date-time)

响应状态:

状态码说明schema200OKR201Created401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装objectmsg返回值提示信息string

响应示例:

{ "code": 0, "content": {}, "msg": "" }

5.3. 查询授权历史：根据设备查询授权历史（关联钥匙信息）

接口地址:/key/keyDeviceAuth/authWithKey

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

请求参数:

参数名称参数说明in是否必须数据类型schemacurrent当前页queryfalseinteger(int32)deviceIddeviceIdqueryfalseinteger(int64)pagingqueryfalsebooleansize每页显示条数queryfalseinteger(int32)

响应状态:

状态码说明schema200OKR401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装objectmsg返回值提示信息string

响应示例:

{ "code": 0, "content": {}, "msg": "" }

6. 其它

6.1. 查询区域列表

接口地址:/common/commonDistrict

请求方式:GET

请求数据类型:*

响应数据类型:*/*

接口描述:

请求参数:

请求参数:

暂无

响应状态:

状态码说明schema200OKR401Unauthorized403Forbidden404Not Found

响应参数:

参数名称参数说明类型schemacode返回码integer(int32)integer(int32)content返回值包装objectmsg返回值提示信息string

响应示例:

{ "code": 0, "content": {}, "msg": "" }