广州市电梯无纸化维保平台数据接口规范.docVIP

广州市电梯无纸化维保平台数据接口规范 （第一版） 广州市电梯安全运行监控中心 2020年5月20日  概述 本开发指南主要用于指导使用自有维保平台或第三方维保管理平台的维保单位与广州市电梯智慧维保平台完成无纸化维保API的对接。主要包含申请账号、token令牌申请、数据交换等。 约定 统一的消息返回格式 参数 类型 说明 code Int 返回代码 200为成功，其他见错误码 message String 返回信息 data 泛型 具体内容 关于账号 对于要接入广州市电梯智慧维保平台的平台，运维人员会给企业或第三方平台开设账号，并线下分配appKey和appSecret。 关于坐标 统一采用GCJ-02坐标系 统一请求头Header设置 Content-Type : application/json Authorization : Bearer token 说明：token在请求 3.1获取token 后获取，除了此接口，调用其他接口都需要在请求头中设置token信息。 开发前准备 维保单位需提供维保检查项清单，清单结构见附件 接口定义 获取token 接口说明 根据线下分配的appKey和appSecret调用接口，申请新令牌时，旧令牌会过期 接口地址(测试环境)： https://域名:端口/datacenter/api/v1/platform/getToken 请求方式： post 请求头： Content-Type：application/json 请求参数： 参数 描述 类型 是否允许空 说明 appKey 接入方用户唯一凭证 VARCHAR 否 线下分配 appSecret 凭证对应的秘钥 VARCHAR 否 线下分配 请求示例： { appKey:6ea663736512ae887e324397893ea26f75d9a33195f6059c60028f71a8a62c8a, appSecret:7sad7ags7ga7sgf7glhjs99j397893ea26f75d9a33195f6059c60028f71a8a62ca } 返回参数： 参数 描述 类型 是否允许空 说明 code 返回码 INTEGER 否 mssage 返回描述信息 VARCHAR 否 data object data数据结构 参数 描述 类型 是否允许空 说明 token 令牌，用于后续接口访问 VARCHAR 否 expiresTime 过期时间 INTEGER 否 单位：秒 上传图片（保养项图片、维保单位人员签名、使用单位人员签名） 接口说明 维保记录中涉及的相关图片都要请求此接口上传图片，并在后续接口中用返回的图片唯一标识提交数据 接口地址(测试环境)： https://域名:端口/datacenter/api/v1/fwbg/uploadFile 请求方式： post 请求头： Content-Type：application/json 请求参数： 参数 描述 类型 是否允许空 说明 file 图片 FILE 否 最大10M 返回参数： 参数 描述 类型 是否允许空 说明 code 返回码 INTEGER 否 mssage 返回描述信息 VARCHAR 否 data object data数据结构 参数 描述 类型 是否允许空 说明 fileId 图片唯一标识 VARCHAR 否 维保记录上传 接口说明 调用该接口上传维保记录，当请求失败时需要检查失败原因并修正重传，对于重传仍然失败的需要记录并联系接口人。 接口地址(测试环境)： https://域名:端口/datacenter/api/v1/fwbg/add 请求方式： post 请求头： Content-Type：application/json 请求参数： 参数 描述 类型 是否允许空 说明 registerCode 注册代码 VARCHAR 否 maintenanceUnitCode 维保单位信用代码 VARCHAR 否 maintenanceUnitName 维保单位名称 VARCHAR 否 wbzqId 维保周期id（对应《检查项清单》维保周期id） VARCHAR 否 workerList 执行此次维保工作的维保工信息列表 VARCHAR 否 至少传两条数据，即至少有两个维保工在现场维保 useUnitSign 使用单位签名图片唯一标识（调用上传图片接口返回） VARCHAR 是 可以先提交维保记录，后补使用单位签名 signTime 维保签到时间 LONG 否 时间戳 精确到毫秒 signLon 维保签到时的经度 VARCHAR 否 signLat 维保签到时的纬度 VARCHAR 否 completeTime 维保完成时间