物聯(lián)網(wǎng)智慧平臺廠家接口規(guī)范(IOT服務(wù)接口規(guī)范)(一)

版本修訂修改記錄累積了每次文檔更新的說明。

文檔版本軟件版本發(fā)布日期修改說明

初始版本

修改設(shè)備編號（井蓋下有不同設(shè)備區(qū)分）

門禁添加狀態(tài)，請求地址修改

vl.03添加北向接口，修改調(diào)整接口路徑url

目錄

1目錄3

2前言8

3南向接口8

3.1應(yīng)用平安（鑒權(quán)）8

3.1.1接口描述8

3.1.2接口地址9

3.1.3獲取方式9

3.1.4請求參數(shù)9

3.1.5響應(yīng)信息9

3.1.6消息例如9

3.2設(shè)備基礎(chǔ)數(shù)據(jù)接口10

3.2.1接口描述10

3.2.2接口地址10

3.2.3獲取方式10

3.2.4請求參數(shù)10

請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

app_keystring是應(yīng)用id

devicejdstring是設(shè)備ID

是

device_statusstring設(shè)備狀態(tài)0:開，1：關(guān)

recordtimestring是記錄時間:yyyy-MMI-ddHH：mm：ss

響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

是

res__codeint響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.5.6；肖息、例如

1.6小表數(shù)據(jù)接口

1.6.1接口描述

1.6.2接口地址

1.6.3獲取方式

POST

1.6.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

叩p_keystring是應(yīng)用id

devicejdstring是設(shè)備ID

water_degreestring是水表度數(shù)

signaljntensitystring是信號強度

recordtimestring是記錄時間：yyyy-MM-ddHH:mm:ss

1.6.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

res__codeint是響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.6.6；肖息例如

1.7大表數(shù)據(jù)接口

1.7.1接口描述

1.7.2接口地址

1.7.3獲取方式

POST

1.7.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

app_keystring是應(yīng)用id

devicejdstring是設(shè)備ID

forward_flowstring是正向流量

reverse_flowstring是反向流量

pressurestring是壓力

temperaturestring是溫度

signaljntensitystring是信號強度

recordtimestring是記錄時間：yyyy-MM-ddHH:mm:ss

1.7.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

是

res_codeint響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.7.6消息例如

1.8消防栓數(shù)據(jù)接口

1.8.1接口描述

1.8.2接口地址

1.8.3獲取方式

POST

1.8.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

是

app.keystring應(yīng)用id

devicejdstring是設(shè)備ID

pressurestring是壓力

temperaturestring是溫度

signaljntensitystring是信號強度

recordtimestring是記錄時間：yyyy-MM-ddHH:mm：ss

1.8.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

是

res_codeint響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回7寸應(yīng)的描述信息。

1.8.6；肖息例如

1.9水表告警數(shù)據(jù)接口

1.9.1接口描述

1.9.2接口地址

1.9.3獲取方式

POST

1.9.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

是

叩p_keystring應(yīng)用id

devicejdstring是設(shè)備ID

alarmjnfostring是告警信息

device_statusstring是設(shè)備狀態(tài)，有那些值？

recordtimestring是記錄時間：yyyy-MM-ddHH:mm:ss

1.9.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

res_codeint是響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.9.6消息例如

1.10煙感告警數(shù)據(jù)接口

1.10.1接口描述

1.10.2接口地址

1.10.3獲取方式

POST

1.10.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

是

app.keystring應(yīng)用id

是

devicejdstring設(shè)備ID

告警類型1：上線，2:失聯(lián)，3:煙霧告警，4:火警，5:電量

alarm_typestring是

正常，6:電量低，7：撤除，8:自檢故障，9：煙霧告警解除，

10:火警解除

是

recordtimestring記錄時間：yyyy-MM-ddHH:mm:ss

1.10.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

是

res_codeint響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.10.6；肖息例如

1.11攝像頭數(shù)據(jù)接口（小區(qū)口）

1.11.1接口描述

1.11.2接口地址

1.11.3獲取方式

POST

參數(shù)名稱數(shù)據(jù)類型必填說明

叩p_keystring是應(yīng)用id

devicejdstring是設(shè)備ID

userstring是用戶手機號碼，編號，卡號？

是

user_typestring人員類型0：臨時，1：固定

house_floorstring是戶主樓層

是

in_out_statusstring進出狀態(tài)0：進，1：出

user_image_urlstring是最新人員圖片地址

recordtimestring是記錄時間：yyyy-MM-ddHH:mm：ss

參數(shù)名稱數(shù)據(jù)類型必填說明

是

res_codeint響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.12路燈照明數(shù)據(jù)接口

1.12.1接口描述

1.12.2接口地址

1.12.3獲取方式

POST

1.12.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

app.keystring是應(yīng)用id

是

devicejdstring設(shè)備ID

lighting_statusstring是照明狀態(tài)0：開，1：關(guān)

brightnessstring是亮度百分比

voltagestring是電壓V

electricitystring是電流單位？

recordtimestring是記錄時間：yyyy-MM-ddHH：mm：ss

1.12.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

是

res_codeint響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.12.6消息例如

1.13路燈照明指令接口

1.13.1接口描述向設(shè)備發(fā)送指令，控制路燈開關(guān)。

1.13.2接口地址需要廠商提供服務(wù)地址

1.13.3獲取方式

POST

1.13.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

是

devicejdstring設(shè)備ID

lighting_statusstring是照明狀態(tài)0:開，1：關(guān)

1.13.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

是

res__codeint響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.13.6消息例如

1.14門禁數(shù)據(jù)接口

1.14.1接口描述

1.14.2接口地址

1.14.3獲取方式

POST

1.14.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

是

叩p_keystring應(yīng)用id

devicejdstring是設(shè)備ID

open_door_modestring是開門方式：1：卡號,2：密碼,3：微信一維碼

是

userjdstring用戶ID

in_out_statusstring是進出狀態(tài)0：進，1：出，2：異常

user_image_urlstring否用戶圖片地址

recordtimestring是記錄時間:yyyy-MM-ddHH：mm:ss

1.14.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

res_codeint是響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.14.6消息例如

1.15車輛識別數(shù)據(jù)接口

1.15.1接口描述

1.15.2接口地址

1.15.3獲取方式

POST

1.15.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

叩p_keystring是應(yīng)用id

是

devicejdstring設(shè)備ID

car_numberstring是車牌號

是

in_out_statusstring進出狀態(tài)0：進，1：出

recordtimestring是時間:yyyy-MM-ddHH:mm:ss

1.15.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

res_codeint是響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.1.5響應(yīng)信息11

1.1.6消息例如11

3.3充電樁數(shù)據(jù)接口12

3.3.1接口描述12

3.3.2接口地址12

3.3.3獲取方式12

3.3.4請求參數(shù)12

3.3.5響應(yīng)信息13

3.3.6消息例如13

3.4井蓋數(shù)據(jù)接口13

3.4.1接口描述13

3.4.2接口地址13

3.4.3獲取方式14

3.4.4請求參數(shù)14

3.4.5響應(yīng)信息14

3.4.6消息例如14

3.5井蓋告警數(shù)據(jù)接口15

3.5.1接口描述16

3.5.2接口地址16

3.5.3獲取方式16

3.5.4請求參數(shù)16

3.5.5響應(yīng)信息16

3.5.6消息例如17

3.6小表數(shù)據(jù)接口17

3.6.1接口描述17

3.6.2接口地址17

3.6.3獲取方式17

3.6.4請求參數(shù)17

3.6.5響應(yīng)信息18

3.6.6消息例如18

3.7大表數(shù)據(jù)接口19

3.7.1接口描述19

3.7.2接口地址19

3.7.3獲取方式19

3.7.4請求參數(shù)19

3.7.5響應(yīng)信息20

3.7.6消息例如20

3.8消防栓數(shù)據(jù)接口20

3.8.1接口描述20

消息例如

1.16地磁數(shù)據(jù)接口

1.16.1接口描述

1.16.2接口地址

1.16.3獲取方式

POST

1.16.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

是

app_keystring應(yīng)用id

devicejdstring是設(shè)備ID

device_statusstring是設(shè)備狀態(tài)0：空閑，1：占用

recordtimestring是記錄時間：yyyy-MM-ddHH：mm:ss

1.16.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

是

res_codeint響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.16.6消息例如

1.17環(huán)境監(jiān)測數(shù)據(jù)接口

1.17.1接口描述

1.17.2接口地址

1.17.3獲取方式

POST

1.17.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

是

app.keystring應(yīng)用id

devicejdstring是設(shè)備ID

pm25string是PM2.5

temperaturestring是溫度

humiditystring是濕度

noisestring是噪音

recordtimestring是記錄時間：yyyy-MM-ddHH:mm:ss

1.17.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

是

res_codeint響應(yīng)碼。0：成功，其他：失敗。

res__messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

1.17.6消息例如

接口

1.18數(shù)據(jù)接口

1.18.1接口描述目前無定義

1.18.2接口地址

1.18.3獲取方式

POST

1.18.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

app_keystring是應(yīng)用id

devicejdstring是設(shè)備ID

device_typestring是設(shè)備類型

page_noint否分頁查詢參數(shù)，pageNo=null時查詢內(nèi)容不分頁;取值大于

等十0的整數(shù)時分頁食詢，等十0時查詢第一頁

page_sizeint否分頁查詢參數(shù)，取值大于等于1的整數(shù)，缺省值為1

start_timestring否查詢參數(shù)，根據(jù)時間段查詢的起始時間；時間格式：yyyy-MM-

ddHH:mm:ss如:2015-12-1112:12:12,缺省值當(dāng)月

end_timestring否查詢參數(shù)，根據(jù)時間段查詢的結(jié)束時間；時間格式：yyyy-MM-

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

1.18.5響應(yīng)信息deviceJst根據(jù)設(shè)備類型不同，數(shù)據(jù)說明如下

參數(shù)名稱數(shù)據(jù)類型必填說明

res__codeint是響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

total_countint是查詢的記錄數(shù)量

page_noint是返回的頁碼序號（大于等十0的整數(shù),0代表第一頁）

是

page_sizeint頁碼大小，當(dāng)不分頁查詢時，取值等于totalcount

devicejistarray是設(shè)備數(shù)據(jù)

融動車充小樁

參數(shù)名稱數(shù)據(jù)類型必填說明

host_statusstring是主機狀態(tài)0：在線，1：離線

free_portstring是空閑端口

use_portstring是在用端口

fault_portstring是故障端口

total_portstring是總端口

recordtimestring是記錄時間:yyyy-MM-ddHH:mm:ss

井蓋

參數(shù)名稱數(shù)據(jù)類型必填說明

acquisition_valuestring是采集值

recordtimestring是記錄時間:yyyy-MM-ddHH:mm:ss

是

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

井蓋告警

參數(shù)名稱數(shù)據(jù)類型必填說明

是

device_statusstring設(shè)備狀態(tài)0：開，1:關(guān)

recordtimestring是記錄時間：yyyy-MM-ddHH:mm:ss

水表（?。?/p>

參數(shù)名稱數(shù)據(jù)類型必填說明

water_degreestring是水表度數(shù)

signaljntensitystring是信號強度

recordtimestring是記錄時間：yyyy-MM-ddHH：mm：ss

水表（大）

參數(shù)名稱數(shù)據(jù)類型必填說明

forward_flowstring是正向流量

reverse_flowstring是反向流量

pressurestring是壓力

temperaturestring是溫度

signaljntensitystring是信號強度

recordtimestring是記錄時間:yyyy-MM-ddHH:mm:ss

消防栓

參數(shù)名稱數(shù)據(jù)類型必填說明

pressurestring是壓力

temperaturestring是溫度

signaljntensitystring是信號強度

recordtimestring是記錄時間：yyyy-MM-ddHH：mm：ss

水表告警

參數(shù)名稱數(shù)據(jù)類型必填說明

alarmjnfostring是告警信息

device_statusstring是設(shè)備狀態(tài)，有那些值？

recordtimestring是記錄時間：yyyy-MM-ddHH:mm:ss

煙感告警

參數(shù)名稱數(shù)據(jù)類型必填說明

告警類型1：上線，2:失聯(lián)，3:煙霧告警，4:

alarm_typestring是

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

檢故障，9：煙霧告警解除，10：火警解除

recordtimestring是記錄時間：yyyy-MM-ddHH:mm:ss

攝像頭

參數(shù)名稱數(shù)據(jù)類型必填說明

userstring是用戶手機號碼，編號，卡號？

user_typestring是人員類型0：臨時，1:固定

house_floorstring是戶主樓層

是

in_out_statusstring進出狀態(tài)0:進，1：出

userjmage_urlstring是最新人員圖片地址

recordtimestring是記錄時間:yyyy-MM-ddHH：mm:ss

橋燈照明

參數(shù)名稱數(shù)據(jù)類型必填說明

lighting-statusstring是照明狀態(tài)0：開，1：關(guān)

brightnessstring是亮度百分比

voltagestring是電壓V

electricitystring是電流單位？

recordtimestring是記錄時間:yyyy-MM-ddHH:mm:ss

參數(shù)名稱數(shù)據(jù)類型必填說明

open_door_modestring是開門方式

是

userjdstring用戶ID卡號，密碼，微信一維碼

user_image_urlstring是用戶圖片地址

recordtimestring是記錄時間：yyyy-MM-ddHH：mm：ss

筆輛識

參數(shù)名稱數(shù)據(jù)類型必填說明

car_numberstring是車牌號

是

in_out_statusstring進出狀態(tài)0:進，1:出

是

recordtimestring記錄時間：yyyy-MM-ddHH:mm:ss

地磁

參數(shù)名稱數(shù)據(jù)類型必填說明

告警類型1：上線，2:失聯(lián)，3:煙霧告警，4:

alarm_typestring是

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

檢故障，9：煙霧告警解除，10：火警解除

recordtimestring是記錄時間:yyyy-MM-ddHH:mm:ss

環(huán)境監(jiān)測

參數(shù)名稱數(shù)據(jù)類型必填說明

pm25string是PM2.5

temperaturestring是溫度

humiditystring是濕度

noisestring是噪音

recordtimestring是記錄時間:yyyy-MM-ddHH：mm:ss

梯控

代rTE

梯口機

待定

1.18.63肖息'例如數(shù)據(jù)字典

1.19廠商編號描述

平臺統(tǒng)一定義對接廠商的編號，在平臺端唯一標識。

1.19.1字典表

｝一商編匕J商名稱

10001福水智聯(lián)

10002騏馭

10003星海

10004二鑫隆

10005狄奈克

10006冠林

10007逸充

1.20設(shè)備編號描述

平臺統(tǒng)一定義對接設(shè)備的編號，在平臺端唯一標識。

1.20.1字典表

設(shè)備編號設(shè)備名稱

100001水表（?。?/p>

100002水表（大）

100003消防栓

100004煙感

100005井蓋

100006門禁

100007地磁

100008梯控

100009梯口機

100010車輛識別

100011路燈

100012電動車充電樁

100013井蓋井下設(shè)備

100014井蓋路面積水設(shè)備

100015井蓋濁度設(shè)備

100016井蓋流速設(shè)備

1.1.2接口地址21

1.1.3獲取方式21

1.1.4請求參數(shù)21

1.1.5響應(yīng)信息21

1.1.6消息例如21

3.9水表告警數(shù)據(jù)接口22

3.9.1接口描述22

3.9.2接口地址22

3.9.3獲取方式22

3.9.4請求參數(shù)22

3.9.5響應(yīng)信息23

3.9.6消息例如23

3.10煙感告警數(shù)據(jù)接口23

3.10.1接口描述24

3.10.2接口土也址24

3.10.3獲取方式24

3.10.4請求參數(shù)24

3.10.5響應(yīng)信息24

3.10.6消息例如25

3.11攝像頭數(shù)據(jù)接口25

3.11.1接口描述25

3.11.2接口地址25

3.11.3獲取方式25

3.11.4請求參數(shù)求

3.11.5響應(yīng)信息26

3.11.6消息例如26

3.12路燈照明數(shù)據(jù)接口27

3.12.1接口描述27

3.12.2接口地址27

3.12.3獲取方式27

3.12.4請求參數(shù)27

3.12.5響應(yīng)信息28

3.12.6消息例如28

3.13路燈照明指令接口28

3.13.1接口描述29

3.13.2接口地址29

3.13.3獲取方式29

3.13.4請求參數(shù)29

3.13.5響應(yīng)信息29

3.13.6消息例如29

3.14門禁數(shù)據(jù)接口30

3.14.1接口描述30

3.14.2接口地址30

3.14.3獲取方式30

3.14.4請求參數(shù)30

3.14.5響應(yīng)信息31

3.14.6消息例如31

3.15車輛識別數(shù)據(jù)接口31

3.15.1接口描述31

3.15.2接口地址32

3.15.3獲取方式32

3.15.4請求參數(shù)32

3.15.5響應(yīng)信息32

3.15.6消息例如32

3.16地磁數(shù)據(jù)接口33

3.16.1接口描述33

3.16.2接口地址33

3.16.3獲取方式33

3.16.4請求參數(shù)33

3.16.5響應(yīng)信息34

3.16.6消息例如34

3.17環(huán)境監(jiān)測數(shù)據(jù)接口34

3.17.1接口描述34

3.17.2接口地址35

3.17.3獲取方式35

3.17.4請求參數(shù)35

3.17.5響應(yīng)信息35

3.17.6消息例如36

4北向接口36

4.1數(shù)據(jù)接口36

4.1.1接口描述36

4.1.2接口地址37

4.1.3獲取方式37

4.1.4請求參數(shù)37

4.1.5響應(yīng)信息37

4.1.6消息例如38

5數(shù)據(jù)字典38

5.1廠商編號38

5.1.1描述38

5.1.2字典表39

5.2設(shè)備編號39

5.2.1描述39

5.2.2字典表39

刖百

1、接口列表主要描述能力開放的接口集合，詳細介紹每個接口的功能、輸入?yún)?shù)、輸出參數(shù)、和消息樣例等信息。

2、接口調(diào)用都需要在request中攜帶參數(shù)app_key,用來區(qū)分不同廠商的數(shù)據(jù)。

3、接口使用UTF-8作為編碼。

4、除了應(yīng)用平安（鑒權(quán)）接口，其他接口有對應(yīng)token鑒權(quán)。

5、接口地址servenport替換平臺提供的測試環(huán)境地址IP和端口或現(xiàn)網(wǎng)地址1P和端口。測試服務(wù)器

IP:,端口:

南向接口

1.1應(yīng)用平安（鑒權(quán)）調(diào)用鑒權(quán)接口，獲取鑒權(quán)token。

1.1.1接口描述實現(xiàn)第三方系統(tǒng)在訪問開放APT之前的認證。

鑒權(quán)接口是調(diào)用其他API的前提，其他接口調(diào)用都需要在requestheader中攜帶參數(shù)app_key和Authorization:Bearer

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

LL2接口地址

1.1.3獲取方式POST

1.1.4請求參數(shù)

參數(shù)名稱數(shù)據(jù)類型必填說明

是

叩p_keystring應(yīng)用id,用戶名

secretstring是密鑰，登錄用戶口令

1.1.5響應(yīng)信息

參數(shù)名稱數(shù)據(jù)類型必填說明

res_codeint是響應(yīng)碼。0:成功，其他：失敗。

res_messagestring是響應(yīng)描述:返回對應(yīng)的描述信息。

tokenTypeString是鑒權(quán)token類型，默認值bearer

expireslnInteger是平臺生成并返回accessToken的有效時間，單位秒

accessTokenString是鑒權(quán)參數(shù)

1.1.6消息例如

1.2設(shè)備基礎(chǔ)數(shù)據(jù)接口

1.2.1接口描述

1.2.2接口地址

1.2.3獲取方式

POST

1.2.4請求參數(shù)

參數(shù)