物联网智慧平台厂家接口规范(IOT服务接口规范)(一)

版本修订修改记录累积了每次文档更新的说明。

文档版本软件版本发布日期修改说明

初始版本

修改设备编号（井盖下有不同设备区分）

门禁添加状态，请求地址修改

vl.03添加北向接口，修改调整接口路径url

目录

1目录3

2前言8

3南向接口8

3.1应用平安（鉴权）8

3.1.1接口描述8

3.1.2接口地址9

3.1.3获取方式9

3.1.4请求参数9

3.1.5响应信息9

3.1.6消息例如9

3.2设备基础数据接口10

3.2.1接口描述10

3.2.2接口地址10

3.2.3获取方式10

3.2.4请求参数10

请求参数

参数名称数据类型必填说明

app_keystring是应用id

devicejdstring是设备ID

是

device_statusstring设备状态0:开，1：关

recordtimestring是记录时间:yyyy-MMI-ddHH：mm：ss

响应信息

参数名称数据类型必填说明

是

res__codeint响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.5.6；肖息、例如

1.6小表数据接口

1.6.1接口描述

1.6.2接口地址

1.6.3获取方式

POST

1.6.4请求参数

参数名称数据类型必填说明

叩p_keystring是应用id

devicejdstring是设备ID

water_degreestring是水表度数

signaljntensitystring是信号强度

recordtimestring是记录时间：yyyy-MM-ddHH:mm:ss

1.6.5响应信息

参数名称数据类型必填说明

res__codeint是响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.6.6；肖息例如

1.7大表数据接口

1.7.1接口描述

1.7.2接口地址

1.7.3获取方式

POST

1.7.4请求参数

参数名称数据类型必填说明

app_keystring是应用id

devicejdstring是设备ID

forward_flowstring是正向流量

reverse_flowstring是反向流量

pressurestring是压力

temperaturestring是温度

signaljntensitystring是信号强度

recordtimestring是记录时间：yyyy-MM-ddHH:mm:ss

1.7.5响应信息

参数名称数据类型必填说明

是

res_codeint响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.7.6消息例如

1.8消防栓数据接口

1.8.1接口描述

1.8.2接口地址

1.8.3获取方式

POST

1.8.4请求参数

参数名称数据类型必填说明

是

app.keystring应用id

devicejdstring是设备ID

pressurestring是压力

temperaturestring是温度

signaljntensitystring是信号强度

recordtimestring是记录时间：yyyy-MM-ddHH:mm：ss

1.8.5响应信息

参数名称数据类型必填说明

是

res_codeint响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回7寸应的描述信息。

1.8.6；肖息例如

1.9水表告警数据接口

1.9.1接口描述

1.9.2接口地址

1.9.3获取方式

POST

1.9.4请求参数

参数名称数据类型必填说明

是

叩p_keystring应用id

devicejdstring是设备ID

alarmjnfostring是告警信息

device_statusstring是设备状态，有那些值？

recordtimestring是记录时间：yyyy-MM-ddHH:mm:ss

1.9.5响应信息

参数名称数据类型必填说明

res_codeint是响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.9.6消息例如

1.10烟感告警数据接口

1.10.1接口描述

1.10.2接口地址

1.10.3获取方式

POST

1.10.4请求参数

参数名称数据类型必填说明

是

app.keystring应用id

是

devicejdstring设备ID

告警类型1：上线，2:失联，3:烟雾告警，4:火警，5:电量

alarm_typestring是

正常，6:电量低，7：撤除，8:自检故障，9：烟雾告警解除，

10:火警解除

是

recordtimestring记录时间：yyyy-MM-ddHH:mm:ss

1.10.5响应信息

参数名称数据类型必填说明

是

res_codeint响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.10.6；肖息例如

1.11摄像头数据接口（小区口）

1.11.1接口描述

1.11.2接口地址

1.11.3获取方式

POST

参数名称数据类型必填说明

叩p_keystring是应用id

devicejdstring是设备ID

userstring是用户手机号码，编号，卡号？

是

user_typestring人员类型0：临时，1：固定

house_floorstring是户主楼层

是

in_out_statusstring进出状态0：进，1：出

user_image_urlstring是最新人员图片地址

recordtimestring是记录时间：yyyy-MM-ddHH:mm：ss

参数名称数据类型必填说明

是

res_codeint响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.12路灯照明数据接口

1.12.1接口描述

1.12.2接口地址

1.12.3获取方式

POST

1.12.4请求参数

参数名称数据类型必填说明

app.keystring是应用id

是

devicejdstring设备ID

lighting_statusstring是照明状态0：开，1：关

brightnessstring是亮度百分比

voltagestring是电压V

electricitystring是电流单位？

recordtimestring是记录时间：yyyy-MM-ddHH：mm：ss

1.12.5响应信息

参数名称数据类型必填说明

是

res_codeint响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.12.6消息例如

1.13路灯照明指令接口

1.13.1接口描述向设备发送指令，控制路灯开关。

1.13.2接口地址需要厂商提供服务地址

1.13.3获取方式

POST

1.13.4请求参数

参数名称数据类型必填说明

是

devicejdstring设备ID

lighting_statusstring是照明状态0:开，1：关

1.13.5响应信息

参数名称数据类型必填说明

是

res__codeint响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.13.6消息例如

1.14门禁数据接口

1.14.1接口描述

1.14.2接口地址

1.14.3获取方式

POST

1.14.4请求参数

参数名称数据类型必填说明

是

叩p_keystring应用id

devicejdstring是设备ID

open_door_modestring是开门方式：1：卡号,2：密码,3：微信一维码

是

userjdstring用户ID

in_out_statusstring是进出状态0：进，1：出，2：异常

user_image_urlstring否用户图片地址

recordtimestring是记录时间:yyyy-MM-ddHH：mm:ss

1.14.5响应信息

参数名称数据类型必填说明

res_codeint是响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.14.6消息例如

1.15车辆识别数据接口

1.15.1接口描述

1.15.2接口地址

1.15.3获取方式

POST

1.15.4请求参数

参数名称数据类型必填说明

叩p_keystring是应用id

是

devicejdstring设备ID

car_numberstring是车牌号

是

in_out_statusstring进出状态0：进，1：出

recordtimestring是时间:yyyy-MM-ddHH:mm:ss

1.15.5响应信息

参数名称数据类型必填说明

res_codeint是响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.1.5响应信息11

1.1.6消息例如11

3.3充电桩数据接口12

3.3.1接口描述12

3.3.2接口地址12

3.3.3获取方式12

3.3.4请求参数12

3.3.5响应信息13

3.3.6消息例如13

3.4井盖数据接口13

3.4.1接口描述13

3.4.2接口地址13

3.4.3获取方式14

3.4.4请求参数14

3.4.5响应信息14

3.4.6消息例如14

3.5井盖告警数据接口15

3.5.1接口描述16

3.5.2接口地址16

3.5.3获取方式16

3.5.4请求参数16

3.5.5响应信息16

3.5.6消息例如17

3.6小表数据接口17

3.6.1接口描述17

3.6.2接口地址17

3.6.3获取方式17

3.6.4请求参数17

3.6.5响应信息18

3.6.6消息例如18

3.7大表数据接口19

3.7.1接口描述19

3.7.2接口地址19

3.7.3获取方式19

3.7.4请求参数19

3.7.5响应信息20

3.7.6消息例如20

3.8消防栓数据接口20

3.8.1接口描述20

消息例如

1.16地磁数据接口

1.16.1接口描述

1.16.2接口地址

1.16.3获取方式

POST

1.16.4请求参数

参数名称数据类型必填说明

是

app_keystring应用id

devicejdstring是设备ID

device_statusstring是设备状态0：空闲，1：占用

recordtimestring是记录时间：yyyy-MM-ddHH：mm:ss

1.16.5响应信息

参数名称数据类型必填说明

是

res_codeint响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

1.16.6消息例如

1.17环境监测数据接口

1.17.1接口描述

1.17.2接口地址

1.17.3获取方式

POST

1.17.4请求参数

参数名称数据类型必填说明

是

app.keystring应用id

devicejdstring是设备ID

pm25string是PM2.5

temperaturestring是温度

humiditystring是湿度

noisestring是噪音

recordtimestring是记录时间：yyyy-MM-ddHH:mm:ss

1.17.5响应信息

参数名称数据类型必填说明

是

res_codeint响应码。0：成功，其他：失败。

res__messagestring是响应描述:返回对应的描述信息。

1.17.6消息例如

接口

1.18数据接口

1.18.1接口描述目前无定义

1.18.2接口地址

1.18.3获取方式

POST

1.18.4请求参数

参数名称数据类型必填说明

app_keystring是应用id

devicejdstring是设备ID

device_typestring是设备类型

page_noint否分页查询参数，pageNo=null时查询内容不分页;取值大于

等十0的整数时分页食询，等十0时查询第一页

page_sizeint否分页查询参数，取值大于等于1的整数，缺省值为1

start_timestring否查询参数，根据时间段查询的起始时间；时间格式：yyyy-MM-

ddHH:mm:ss如:2015-12-1112:12:12,缺省值当月

end_timestring否查询参数，根据时间段查询的结束时间；时间格式：yyyy-MM-

ddHH:mm:ss如：2015-12-1212:12:12

1.18.5响应信息deviceJst根据设备类型不同，数据说明如下

参数名称数据类型必填说明

res__codeint是响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

total_countint是查询的记录数量

page_noint是返回的页码序号（大于等十0的整数,0代表第一页）

是

page_sizeint页码大小，当不分页查询时，取值等于totalcount

devicejistarray是设备数据

融动车充小桩

参数名称数据类型必填说明

host_statusstring是主机状态0：在线，1：离线

free_portstring是空闲端口

use_portstring是在用端口

fault_portstring是故障端口

total_portstring是总端口

recordtimestring是记录时间:yyyy-MM-ddHH:mm:ss

井盖

参数名称数据类型必填说明

acquisition_valuestring是采集值

recordtimestring是记录时间:yyyy-MM-ddHH:mm:ss

是

typestring类型0：井下，1:路面枳水，2：浊度，3:流速

井盖告警

参数名称数据类型必填说明

是

device_statusstring设备状态0：开，1:关

recordtimestring是记录时间：yyyy-MM-ddHH:mm:ss

水表（小）

参数名称数据类型必填说明

water_degreestring是水表度数

signaljntensitystring是信号强度

recordtimestring是记录时间：yyyy-MM-ddHH：mm：ss

水表（大）

参数名称数据类型必填说明

forward_flowstring是正向流量

reverse_flowstring是反向流量

pressurestring是压力

temperaturestring是温度

signaljntensitystring是信号强度

recordtimestring是记录时间:yyyy-MM-ddHH:mm:ss

消防栓

参数名称数据类型必填说明

pressurestring是压力

temperaturestring是温度

signaljntensitystring是信号强度

recordtimestring是记录时间：yyyy-MM-ddHH：mm：ss

水表告警

参数名称数据类型必填说明

alarmjnfostring是告警信息

device_statusstring是设备状态，有那些值？

recordtimestring是记录时间：yyyy-MM-ddHH:mm:ss

烟感告警

参数名称数据类型必填说明

告警类型1：上线，2:失联，3:烟雾告警，4:

alarm_typestring是

火警，5:电量正常，6:电量低，7：撤除，8:自

检故障，9：烟雾告警解除，10：火警解除

recordtimestring是记录时间：yyyy-MM-ddHH:mm:ss

摄像头

参数名称数据类型必填说明

userstring是用户手机号码，编号，卡号？

user_typestring是人员类型0：临时，1:固定

house_floorstring是户主楼层

是

in_out_statusstring进出状态0:进，1：出

userjmage_urlstring是最新人员图片地址

recordtimestring是记录时间:yyyy-MM-ddHH：mm:ss

桥灯照明

参数名称数据类型必填说明

lighting-statusstring是照明状态0：开，1：关

brightnessstring是亮度百分比

voltagestring是电压V

electricitystring是电流单位？

recordtimestring是记录时间:yyyy-MM-ddHH:mm:ss

参数名称数据类型必填说明

open_door_modestring是开门方式

是

userjdstring用户ID卡号，密码，微信一维码

user_image_urlstring是用户图片地址

recordtimestring是记录时间：yyyy-MM-ddHH：mm：ss

笔辆识

参数名称数据类型必填说明

car_numberstring是车牌号

是

in_out_statusstring进出状态0:进，1:出

是

recordtimestring记录时间：yyyy-MM-ddHH:mm:ss

地磁

参数名称数据类型必填说明

告警类型1：上线，2:失联，3:烟雾告警，4:

alarm_typestring是

火警，5:电量正常，6:电量低，7：撤除，8:自

检故障，9：烟雾告警解除，10：火警解除

recordtimestring是记录时间:yyyy-MM-ddHH:mm:ss

环境监测

参数名称数据类型必填说明

pm25string是PM2.5

temperaturestring是温度

humiditystring是湿度

noisestring是噪音

recordtimestring是记录时间:yyyy-MM-ddHH：mm:ss

梯控

代rTE

梯口机

待定

1.18.63肖息'例如数据字典

1.19厂商编号描述

平台统一定义对接厂商的编号，在平台端唯一标识。

1.19.1字典表

｝一商编匕J商名称

10001福水智联

10002骐驭

10003星海

10004二鑫隆

10005狄奈克

10006冠林

10007逸充

1.20设备编号描述

平台统一定义对接设备的编号，在平台端唯一标识。

1.20.1字典表

设备编号设备名称

100001水表（小）

100002水表（大）

100003消防栓

100004烟感

100005井盖

100006门禁

100007地磁

100008梯控

100009梯口机

100010车辆识别

100011路灯

100012电动车充电桩

100013井盖井下设备

100014井盖路面积水设备

100015井盖浊度设备

100016井盖流速设备

1.1.2接口地址21

1.1.3获取方式21

1.1.4请求参数21

1.1.5响应信息21

1.1.6消息例如21

3.9水表告警数据接口22

3.9.1接口描述22

3.9.2接口地址22

3.9.3获取方式22

3.9.4请求参数22

3.9.5响应信息23

3.9.6消息例如23

3.10烟感告警数据接口23

3.10.1接口描述24

3.10.2接口土也址24

3.10.3获取方式24

3.10.4请求参数24

3.10.5响应信息24

3.10.6消息例如25

3.11摄像头数据接口25

3.11.1接口描述25

3.11.2接口地址25

3.11.3获取方式25

3.11.4请求参数求

3.11.5响应信息26

3.11.6消息例如26

3.12路灯照明数据接口27

3.12.1接口描述27

3.12.2接口地址27

3.12.3获取方式27

3.12.4请求参数27

3.12.5响应信息28

3.12.6消息例如28

3.13路灯照明指令接口28

3.13.1接口描述29

3.13.2接口地址29

3.13.3获取方式29

3.13.4请求参数29

3.13.5响应信息29

3.13.6消息例如29

3.14门禁数据接口30

3.14.1接口描述30

3.14.2接口地址30

3.14.3获取方式30

3.14.4请求参数30

3.14.5响应信息31

3.14.6消息例如31

3.15车辆识别数据接口31

3.15.1接口描述31

3.15.2接口地址32

3.15.3获取方式32

3.15.4请求参数32

3.15.5响应信息32

3.15.6消息例如32

3.16地磁数据接口33

3.16.1接口描述33

3.16.2接口地址33

3.16.3获取方式33

3.16.4请求参数33

3.16.5响应信息34

3.16.6消息例如34

3.17环境监测数据接口34

3.17.1接口描述34

3.17.2接口地址35

3.17.3获取方式35

3.17.4请求参数35

3.17.5响应信息35

3.17.6消息例如36

4北向接口36

4.1数据接口36

4.1.1接口描述36

4.1.2接口地址37

4.1.3获取方式37

4.1.4请求参数37

4.1.5响应信息37

4.1.6消息例如38

5数据字典38

5.1厂商编号38

5.1.1描述38

5.1.2字典表39

5.2设备编号39

5.2.1描述39

5.2.2字典表39

刖百

1、接口列表主要描述能力开放的接口集合，详细介绍每个接口的功能、输入参数、输出参数、和消息样例等信息。

2、接口调用都需要在request中携带参数app_key,用来区分不同厂商的数据。

3、接口使用UTF-8作为编码。

4、除了应用平安（鉴权）接口，其他接口有对应token鉴权。

5、接口地址servenport替换平台提供的测试环境地址IP和端口或现网地址1P和端口。测试服务器

IP:,端口:

南向接口

1.1应用平安（鉴权）调用鉴权接口，获取鉴权token。

1.1.1接口描述实现第三方系统在访问开放APT之前的认证。

鉴权接口是调用其他API的前提，其他接口调用都需要在requestheader中携带参数app_key和Authorization:Bearer

{accessToken}o注意Bearer和accessToken中间的空格。

LL2接口地址

1.1.3获取方式POST

1.1.4请求参数

参数名称数据类型必填说明

是

叩p_keystring应用id,用户名

secretstring是密钥，登录用户口令

1.1.5响应信息

参数名称数据类型必填说明

res_codeint是响应码。0:成功，其他：失败。

res_messagestring是响应描述:返回对应的描述信息。

tokenTypeString是鉴权token类型，默认值bearer

expireslnInteger是平台生成并返回accessToken的有效时间，单位秒

accessTokenString是鉴权参数

1.1.6消息例如

1.2设备基础数据接口

1.2.1接口描述

1.2.2接口地址

1.2.3获取方式

POST

1.2.4请求参数

参数