建筑扬尘噪音监管平台数据接口标准.doc

— PAGE 2 — 建筑扬尘噪音监管平台数据接口标准 一、总则 为推进AA自治区建筑扬尘噪音监管平台（以下简称本平台）在各地市及项目上的普及应用，为便于各项目采购、安装扬尘噪音监测设备，或已安装有扬尘噪音监测设备的项目接入本平台，特制定本规范。 二、接入要求和前置条件 各平台或设备在接入本平台前，应满足基本条件和特定条件，以下为基本条件： （一）安装要求：已完成现场安装，并且运行良好。若该应用厂家已于事前完成了与本平台对接，则不受该条件限制。 （二）网络要求：现场网络已接入公网，即公网环境能够访问本地数据库，或本地数据能上传至公网平台。 （三）准备工作：熟悉本平台的标准接口，熟悉接入方法和业务逻辑；评估接入本平台的技术难度和现场条件，不具备接入条件的，需完善现场接入环境要求，做到技术上无问题。 三、系统接入接口标准 （一）平台接口调用说明 监管平台提供以下信息用于服务调用： appid 用户唯一凭证 secret 用户唯一凭证秘钥 正式环境http://***************/ 测试Demo： 测试账号（appid）：appIdDemo 测试密钥（secret）：dd4f085459d*********** （二）签名方式 1. 使用系统默认MD5加密。 2. 按照参数名称升序排列。 3. 连接字符串，连接参数名与参数值,并在首尾加上secret。 4. 生成签名，32位大写MD5值。 （三）签名示例 secret：ABCDEFGL 获取项目 ： /api/provide/service/bidareas/info?appid=*******projectId=123 1. 连接字符串（日期字符串不要urlEncode） ABCDEFGLappid*******projectId123ABCDEFGL 2. 生成签名 24B9ACDC4DE23CD6C8E3B5E16678A666 3. 拼接完整请求url /api/provide/service/bidareas/info?appid=*******projectId=123sign=24B9ACDC4DE23CD6C8E3B5E16678A666 4. 通用说明 1）pageSize 最多1000 2）接口返回 返回字段 data 返回的业务数据 code 返回code，详见下面code定义 Message 接口调用返回信息 3）标准 Code 定义 0 成功 40 参数不正确 41 签名错误 42 请求频繁 43 请求超过最大次数 44 其它 5. 接口说明 1）获取租户下项目列表。 根据授权信息获取租户下的项目列表。 2）接口地址： /api/provide/service/projects?appid=APPIDsign=SIGN 方法：get 3）参数说明： 参数 类型 是否必须 说明 appid string 是 唯一凭证 sign string 是 签名 4）返回数据示例 { code: 0, message: success, data: [ { projectId: 123456789, projectName: XX项目, } ], throwable: null } 5）返回字段说明 字段 字段名称 字段格式 备注 projectId 项目ID string 项目ID projectName 项目名称 string 项目名称 6）上报设备状态信息 环境监测设备需要在整点(00:00:00~24:00:00)时向监管平台上报设备状态信息，即每个设备1天需上报24次。 6. 接口地址 1）接入地址： 地址： /api/provide/service/environment/devicet?appid=APPIDsign=SIGN 方式：post 格式：json 参数说明： 参数 类型 是否必须 说明 appid string 是 唯一凭证 sign string 是 签名 projectId String 是 项目ID deviceId String 是 设备ID deviceStatus boolean 是 设备状态；true：可用；false：不可用 dateTime long 是 上报时间（毫秒值） manufactorName String 是 厂商名称 返回示例 { code: 0, message: success, throwable: null } 返回字段说明 字段 字段名称 字段格式 备注 code 返回码 int 0表示成功 message 返回消息 string 返回消息 2）上报环境监测数据 环境监测设备需要在整点(00:00:00~24:00:00)时向监管平