物联网智慧平台厂家接口规范（IOT服务接口规范 ）

版本修订

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

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

vl.0.0初始版本

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

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

vl.0.3添加北向接口，修改调整接口路径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

3.2.5响应信息11

3.2.6消息示例II

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

271接口描述I9

3.7.2接口地址I9

3.7.3获取方式I9

3.7.4请求参数19

3.7.5响应信息20

3.7.6消息示例20

3.8消防栓数据接口20

3.8.1接口描述20

3.8.2接口地址21

3.8.3获取方式21

3.8.4请求参数21

3.8.5响应信息21

3.8.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请求参数25

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

5.1.1描述38

5.1.2字典表39

5.2设备编号39

5.2.1描述39

5.2.2字典表39

<>•

刖百

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

例等信息。

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

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

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

5、接口地址server:porl替换平台提供的测试环境地址IP和端LI或现网地址IP和端口。测试服务器

IP:,端口：

南向接口

1.1应用安全（鉴权）

调用鉴权接口，获取鉴权tcku

1.1.1接口描述

实现第三方系统在访问开放API之前的认证。

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

Authorization:Bearer{accessTokcn}o注意Bearer和accessTokcn中间的空格。

1.1.2接口地址

1.1.3获取方式

POST

1.1.4请求参数

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

app.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请求参数

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

app.keystring是应用id

devicejdstring是设备ID

device_namestring是设备名称

device_service_idstring是设备业务标识（imei）物联网唯一编号

device_install_addressstring是设备地址

latitudejongitudestring是设备定位信息（经纬度）格式

manufacturers_nostring是设备厂商（平台统一定义）

device_typestring是设备类型（平台统一定义）

devicejmagestring是设备图片

operation_typestring是操作1:新增，2:修改，3:删除

1.2.5响应信息

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

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

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

1.2.6消息示例

1.3充电桩数据接口

1.3.1接口描述

13.2获取方式

POST

1.3.3请求参数

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

app_keystring是应用id

devicejdstring是设备ID

host.statusstring是主机状态0:在线，1:离线

free_portstring是空闲端口

use_portstring是在用端口

fault_portstring是故障端口

total_portstring是总端口

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

1.3.4响应］言息、

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

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

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

1.3.5消息示例

1.4井盖数据接口

1.4.1接口描述

1.4.2接口地址

1.4.3获取方式

POST

1.4.4请求参数

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

app_keystring是应用id

devicejdstring是设备ID

acquisition_valuestring是采集值

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

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

1.4.5响应信息

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

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

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

1.4.6消息示例

1.5井盖告警数据接口

1.5.1接口描述

1.5.2接口地址

1.5.3获取方式

POST

1.5.4请求参数

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

app_keystring是应用id

devicejdstring是设备ID

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

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

1.5.5响应信息

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

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

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

1.5.6消息示例

1.6小表数据接口

1.6.1接口描述

1.6.2接口地址

1.6.3获取方式

POST

1.6.4请求参数

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

app.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是响应描述:返回对应的描述信息。

1.8.6消息示例

1.9水表告警数据接口

1.9.1接口描述

1.9.2接口地址

1.9.3获取方式

POST

1.9.4请求参数

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

app_keystring是应用id

devicejdstring是设备ID

alarmjnfostring是告警信息

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

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

1.9.5响应信息

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

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

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

1.9.6；肖息示例

L10烟感告警数据接口

1.10.1接口描述

1.10.2接口地址

1.10.3获取方式

POST

1.10.4请求参数

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

app.keystring是应用id

device_idstring是设备ID

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

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

10:火警解除

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

1.10.5响应信息

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

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

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

1.10.6消息示例

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

1.11.1接口描述

1.11.2接口地址

1.11.3获取方式

POST

1.11.4请求参数

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

app_keystring是应用id

devicejdstring是设备ID

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

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

house_floorstring是户主楼层

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

userjmage_urlstring是最新人员图片地址

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

1.11.5响应信息

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

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

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

1.11.6消息示例

1.12路灯照明数据接口

1.12.1接口描述

1.12.2接口地址

1.12.3获取方式

POST

1.12.4请求参数

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

app.keystring是应用id

device_idstring是设备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请求参数

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

app_keystring是应用id

devicejdstring是设备ID

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

user_idstring是用户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请求参数

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

app_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.15.6消息示例

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响应信息

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

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

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

to:al_countint是直询的记录数量

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

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

devicejistarray是设备数据

devicejist根据设备类型不同，数据说明如下

电动车充电桩

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

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是演

signal_intensitystring是信号强度

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

水表告警

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

alarmjnfostring是告警信息

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

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

烟感告警

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

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

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

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

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

摄喙头

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

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

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

house_floorstring是户主楼层

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

user_image_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

地遨

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

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