李堂庚API接口文档:授权信息与基站锁密码修改

需积分: 0 0 下载量 85 浏览量 更新于2024-08-04 收藏 17KB DOCX 举报
"本文档介绍了两个与智能锁系统相关的API接口,一个是用于工程师抓取授权信息的任务接口,另一个是用于工程师修改基站锁密码的接口。这两个接口都适用于Web端,需要通过POST请求发送特定的参数,并能接收不同类型的服务器响应。" ### 一、工程师任务抓取API接口 #### 功能 此接口主要用于工程师定期获取授权信息,以便进行相关工作。调用此接口的群体主要是Web应用的开发者。 #### 请求详情 - **URL**: `https://www.smartlock.top/v0/taskAuthFetch` - **请求方式**: POST - **请求参数**: - `operatorName`: 操作者用户账号 (String,必填) - `accessToken`: 操作者API动态令牌 (String,必填) #### 服务器返回参数 根据不同的情况,服务器会返回以下四种类型的响应: 1. 成功响应: ```json { "success": { [ { "工单信息" }, { "工单信息" } ] } } ``` 2. 输入错误(未提供申请人的名字): ```json { "error": { "msg": "请输入申请人的名字!", "code": "20002" } } ``` 3. 没有申请任务: ```json { "error": { "msg": "您没有申请任务!", "code": "20001" } } ``` 4. 用户名不存在或动态令牌过期: ```json { "error": { "msg": "用户名不存在或动态令牌已过期", "code": "00000" } } ``` ### 二、工程师修改基站锁密码API接口 #### 功能 此接口允许用户修改基站锁的密码。在使用此接口之前,基站ID必须已存在于数据库中。 #### 请求详情 - **URL**: `https://www.smartlock.top/v0/updateLock` - **请求方式**: POST - **请求参数**: - `operatorName`: 操作者用户账号 (String,必填) - `accessToken`: 操作者API动态令牌 (String,必填) - `LockID`: 锁具ID (String,必填) #### 服务器返回参数 成功时,服务器将返回以下响应: ```json { "success": { "msg": "密码修改成功", "code": "33000" } } ``` 失败时,服务器返回与任务抓取接口相同的错误响应。 ### 存在问题 当工程师在超过任务完成时间后仍未提交作业结果且未标记为异常工单时,可能会出现数据处理上的问题。 ### 参数说明 - **operatorName**: 操作者用户账号 (String,必填) - **accessToken**: 操作者API动态令牌,用于验证操作者的身份 (String,必填) - **applicantName**: 申请人名字 (String,必填) - **applicationStatus**: 任务工单状态 (String,非必填) - **approvalPerson**: 审批人姓名 (String,必填) - **approvalPhone**: 审批人联系方式 (String,非必填) - **applicationType**: 工单类型 (String,非必填) - **taskStartTime**: 任务开始时间 (String,非必填) - **taskEndTime**: 任务结束时间 (String,非必填) 这两个API接口为智能锁系统的管理和维护提供了基础功能,确保了工程师可以有效地获取授权信息并进行必要的设备配置。然而,需要注意的是,未在规定时间内提交结果可能导致数据管理的问题,因此需要及时处理和跟踪工单状态。