一、統(tǒng)一說明
1、通訊方式
數(shù)據(jù)接口采用http協(xié)議，通訊內(nèi)容采用JSON數(shù)據(jù)格式。
接口返回數(shù)據(jù)格式如下：
{"code":1001, "message":"信息內(nèi)容", "data":object}
ResultData字段說明
|
字段 |
類型 |
說明 |
|
code |
integer |
代碼(參考返回代碼說明表) |
|
message |
String |
返回操作結(jié)果描述 |
|
data |
Json |
Json數(shù)據(jù)，具體格式參考各個接口 |
文檔中所有接口的返回數(shù)據(jù)說明表，如無特殊說明均為ResultData數(shù)據(jù)格式，返回的數(shù)據(jù)均存放于data字段中
-
接口調(diào)用注意事項
調(diào)用接口（除測試、登錄接口外）需要將token寫入http請求頭中。請求頭字段名固定為authorization，字段值為獲取token接口獲取到的token值。
接口中如無特殊說明，采用post方法的接口中參數(shù)為json格式，放入請求body中；采用get方法的接口中參數(shù)為查詢參數(shù)，放入請求地址后
-
接口地址
通用云平臺 http://www.xmsiyb.cn/
二、接口詳細
1、身份驗證
1.1 根據(jù)用戶名和密碼獲取token
1.1.1接口描述
|
接口編號 |
1.1 |
|
接口名稱 |
根據(jù)用戶名和密碼獲取token |
|
功能描述 |
獲取登錄所用的token |
|
接口地址 |
/api/getToken |
|
請求方式 |
GET |
|
參數(shù)格式 |
JSON |
|
返回數(shù)據(jù)格式 |
JSON |
|
備注 |
|
1.1.2請求參數(shù)說明
1.1.2.1 請求參數(shù)
|
字段 |
類型 |
說明 |
|
loginName |
String |
登錄名 |
|
password |
String |
登錄密碼 |
1.1.3返回數(shù)據(jù)說明
|
字段 |
類型 |
說明 |
|
code |
int |
狀態(tài)碼 |
|
expiration |
Long |
過期時間 |
|
token |
String |
token令牌 |
|
message |
String |
異常信息 |
1.1.4返回格式示例
{
"code": 0,
"data": {
"expiration": 0,
"token": ""
},
"message": ""
}
2、設備信息操作
2.1 根據(jù)設備地址查詢設備信息
2.1.1接口描述
|
接口編號 |
2.1 |
|
接口名稱 |
根據(jù)設備地址查詢設備信息 |
|
功能描述 |
查詢設備信息 |
|
接口地址 |
/api/device/getDevice |
|
請求方式 |
GET |
|
參數(shù)格式 |
JSON |
|
返回數(shù)據(jù)格式 |
JSON數(shù)組 |
|
備注 |
|
2.1.2請求參數(shù)說明
請求頭
|
header |
必選 |
類型 |
說明 |
|
authorization |
是 |
string |
token |
請求參數(shù)
|
字段 |
類型 |
說明 |
|
deviceAddr |
Integer |
設備地址 |
2.1.3返回數(shù)據(jù)說明
|
字段 |
類型 |
說明 |
|
code |
int |
狀態(tài)碼 |
|
alarmRecord |
Integer |
是否保存報警數(shù)據(jù) 0:不保存 1:保存 |
|
alarmSwitch |
Integer |
報警開關 1:離線報警 2:超限報警 |
|
deviceAddr |
Integer |
設備地址 |
|
deviceName |
String |
設備名稱 |
|
groupId |
String |
分組id |
|
lat |
Double |
緯度 |
|
Lng |
Double |
經(jīng)度 |
|
offlineinterval |
Short |
離線判斷間隔 |
|
savedatainterval |
Short |
保存數(shù)據(jù)間隔 |
|
sort |
Integer |
排序權重 數(shù)字越大權重越高 |
|
useMarkLocation |
Boolean |
使用標記經(jīng)緯度 |
|
alarmDelay |
Integer |
報警延時(分鐘) |
|
alarmRate |
Integer |
報警頻率 |
|
coefficient |
Float |
系數(shù) |
|
deviceAddr |
Integer |
設備地址 |
|
digits |
Integer |
小數(shù)位數(shù) |
|
enabled |
Boolean |
是否啟用 |
|
factorIcon |
String |
因子圖標 |
|
factorId |
String |
因子id |
|
factorName |
String |
因子名稱 |
|
nodeId |
Integer |
節(jié)點id |
|
offset |
Float |
偏差 |
|
registerId |
Integer |
寄存器id |
|
sort |
Integer |
排序權重 |
|
unit |
String |
單位 |
|
Message |
String |
異常信息 |
2.1.4返回格式示例
{
"code": 0,
"data": {
"alarmRecord": 0,
"alarmSwitch": 0,
"deviceAddr": 0,
"deviceName": "",
"factors": [
{
"alarmDelay": 0,
"alarmRate": 0,
"coefficient": 0,
"deviceAddr": 0,
"digits": 0,
"enabled": true,
"factorIcon": "",
"factorId": "",
"factorName": "",
"nodeId": 0,
"offset": 0,
"registerId": 0,
"sort": 0,
"unit": ""
}
],
"groupId": "",
"lat": 0,
"lng": 0,
"offlineinterval": 0,
"savedatainterval": 0,
"sort": 0,
"useMarkLocation": true
},
"message": ""
}
2.2 查詢設備列表
2.2.1接口描述
|
接口編號 |
2.2 |
|
接口名稱 |
查詢設備列表 |
|
功能描述 |
查詢設備列表 |
|
接口地址 |
/api/device/getDeviceList |
|
請求方式 |
GET |
|
參數(shù)格式 |
JSON |
|
返回數(shù)據(jù)格式 |
JSON數(shù)組 |
|
備注 |
|
2.2.2請求參數(shù)說明
請求頭
|
header |
必選 |
類型 |
說明 |
|
authorization |
是 |
string |
token |
請求參數(shù)
|
字段 |
類型 |
說明 |
|
groupId |
String |
組編號，為空則查詢所有設備 |
2.2.3返回數(shù)據(jù)說明
|
字段 |
類型 |
說明 |
|
code |
int |
狀態(tài)碼 |
|
alarmRecord |
Integer |
是否保存報警數(shù)據(jù) 0:不保存 1:保存 |
|
alarmSwitch |
Integer |
報警開關 1:離線報警 2:超限報警 |
|
deviceAddr |
Integer |
設備地址碼 |
|
deviceName |
String |
設備名稱 |
|
groupId |
String |
分組id |
|
lat |
Double |
緯度 |
|
Lng |
Double |
經(jīng)度 |
|
offlineinterval |
Integer |
離線判斷間隔 |
|
savedatainterval |
Short |
保存數(shù)據(jù)間隔 |
|
sort |
Integer |
排序權重 |
|
useMarkLocation |
Boolean |
使用標記經(jīng)緯度 |
|
alarmDelay |
Integer |
報警延時(分鐘) |
|
alarmRate |
Integer |
報警頻率 |
|
coefficient |
Short |
系數(shù) |
|
deviceAddr |
Integer |
設備地址 |
|
digits |
Integer |
小數(shù)位數(shù) |
|
enabled |
Boolean |
是否啟用 |
|
factorIcon |
String |
因子圖標 |
|
factorId |
String |
因子id |
|
factorName |
String |
因子名稱 |
|
nodeId |
Integer |
節(jié)點id |
|
offset |
Float |
偏差 |
|
registerId |
Integer |
寄存器id |
|
sort |
Integer |
排序權重 |
|
unit |
String |
單位 |
|
Message |
String |
異常信息 |
2.2.4返回格式示例
{
"code": 0,
"data": [
{
"alarmRecord": 0,
"alarmSwitch": 0,
"deviceAddr": 0,
"deviceName": "",
"factors": [
{
"alarmDelay": 0,
"alarmRate": 0,
"coefficient": 0,
"deviceAddr": 0,
"digits": 0,
"enabled": true,
"factorIcon": "",
"factorId": "",
"factorName": "",
"nodeId": 0,
"offset": 0,
"registerId": 0,
"sort": 0,
"unit": ""
}
],
"groupId": "",
"lat": 0,
"lng": 0,
"offlineinterval": 0,
"savedatainterval": 0,
"sort": 0,
"useMarkLocation": true
}
],
"message": ""
}
2.3 查詢分組列表
2.3.1接口描述
|
接口編號 |
2.5 |
|
接口名稱 |
查詢分組列表 |
|
功能描述 |
查詢分組列表 |
|
接口地址 |
/api/device/getGroupList |
|
請求方式 |
GET |
|
參數(shù)格式 |
JSON |
|
返回數(shù)據(jù)格式 |
JSON數(shù)組 |
|
備注 |
|
2.3.2請求參數(shù)說明
請求頭
|
header |
必選 |
類型 |
說明 |
|
authorization |
是 |
string |
token |
請求參數(shù)
2.3.3返回數(shù)據(jù)說明
|
字段 |
類型 |
說明 |
|
code |
int |
返回狀態(tài)碼 |
|
groupId |
String |
分組id |
|
groupName |
String |
分組名 |
|
parentId |
String |
上級組名 |
|
message |
String |
異常信息 |
2.3.4返回格式示例
{
"code": 0,
"data": [
{
"groupId": "",
"groupName": "",
"parentId": ""
}
],
"message": ""
}
2.4 根據(jù)設備地址獲取設備繼電器列表
2.4.1接口描述
|
接口編號 |
2.6 |
|
接口名稱 |
根據(jù)設備地址獲取設備繼電器列表 |
|
功能描述 |
根據(jù)設備地址獲取設備繼電器列表 |
|
接口地址 |
/api/device/getRelayList |
|
請求方式 |
Get |
|
參數(shù)格式 |
JSON |
|
返回數(shù)據(jù)格式 |
json |
|
備注 |
|
2.4.2請求參數(shù)說明
請求頭
|
header |
必選 |
類型 |
說明 |
|
authorization |
是 |
string |
token |
請求參數(shù)
|
字段 |
類型 |
說明 |
|
deviceAddr |
Integer |
設備地址 |
2.4.3返回數(shù)據(jù)說明
|
字段 |
類型 |
說明 |
|
code |
int |
返回狀態(tài)碼 |
|
deviceAddr |
Integer |
設備地址 |
|
deviceName |
String |
設備名稱 |
|
enabled |
Boolean |
是否啟用 |
|
relayName |
String |
繼電器名稱 |
|
relayNo |
Integer |
繼電器編號 |
|
message |
String |
異常信息 |
2.4.4返回格式示例
{
"code": 0,
"data": [
{
"deviceAddr": 0,
"deviceName": "",
"enabled": true,
"relayName": "",
"relayNo": 0
}
],
"message": ""
}
2.5 繼電器操作
2.5.1接口描述
|
接口編號 |
2.6 |
|
接口名稱 |
繼電器操作 |
|
功能描述 |
繼電器操作 |
|
接口地址 |
/api/device/setRelay |
|
請求方式 |
POST |
|
參數(shù)格式 |
form-data |
|
返回數(shù)據(jù)格式 |
JSON |
|
備注 |
|
2.5.2請求參數(shù)說明
請求頭
|
header |
必選 |
類型 |
說明 |
|
authorization |
是 |
string |
token |
請求參數(shù)
|
字段 |
類型 |
說明 |
|
deviceAddr |
Integer |
設備地址 |
|
opt |
Integer |
設備操作 0：斷開 1：開啟 |
|
relayNo |
Integer |
繼電器編號 |
2.5.3返回數(shù)據(jù)說明
|
字段 |
類型 |
說明 |
|
code |
int |
狀態(tài)碼 |
|
data |
Boolean |
是否成功 |
|
message |
String |
異常信息 |
2.5.4返回格式示例
{
"code": 0,
"data": true,
"message": ""
}
3、數(shù)據(jù)操作
3.1 獲取歷史數(shù)據(jù)列表
3.1.1接口描述
|
接口編號 |
3.1 |
|
接口名稱 |
獲取歷史數(shù)據(jù)列表 |
|
功能描述 |
獲取歷史數(shù)據(jù)列表 |
|
接口地址 |
/api/data/historyList |
|
請求方式 |
GET |
|
參數(shù)格式 |
form-data |
|
返回數(shù)據(jù)格式 |
JSON數(shù)組 |
|
備注 |
|
3.1.2請求參數(shù)說明
請求頭
|
header |
必選 |
類型 |
說明 |
|
authorization |
是 |
string |
token |
請求參數(shù)
|
字段 |
類型 |
說明 |
|
deviceAddr |
Integer |
設備地址編號 |
|
nodeId |
Integer |
節(jié)點編號（如果查詢所有節(jié)點的數(shù)據(jù)，則nodeid填寫-1） |
|
begintime |
String |
開始時間(YYYY-MM-dd HH:mm:ss) |
|
endTime |
String |
結(jié)束時間(YYYY-MM-dd HH:mm:ss) |
3.1.3返回數(shù)據(jù)說明
|
字段 |
類型 |
說明 |
|
code |
int |
狀態(tài)碼 |
|
alarmLevel |
int |
報警級別 |
|
registerId |
int |
寄存器id |
|
registerName |
String |
寄存器名稱 |
|
text |
String |
數(shù)值 |
|
value |
Double |
數(shù)值 |
|
Lng |
Double |
經(jīng)度 |
|
Lat |
Double |
維度 |
|
deviceAddr |
int |
設備地址 |
|
RecordTime |
long |
記錄時間 |
|
nodeId |
int |
節(jié)點id |
|
recordId |
String |
歷史數(shù)據(jù)id |
|
Message |
String |
異常信息 |
3.1.4返回格式示例
{
"code": 0,
"data": [
{
"data": [
{
"alarmLevel": 0,
"registerId": 0,
"registerName": "",
"text": "",
"value": 0
}
],
"deviceAddr": 0,
"handled": true,
"lat": 0,
"lng": 0,
"nodeId": 0,
"recordId": "",
"recordTime": 0,
"recordTimeStr": ""
}
],
"message": ""
}
3.2刪除歷史數(shù)據(jù)
3.2.1接口描述
|
接口編號 |
3.1 |
|
接口名稱 |
刪除歷史數(shù)據(jù) |
|
功能描述 |
刪除歷史數(shù)據(jù) |
|
接口地址 |
/api/data/delHistory |
|
請求方式 |
POST |
|
參數(shù)格式 |
form-data |
|
返回數(shù)據(jù)格式 |
JSON |
|
備注 |
|
3.2.2請求參數(shù)說明
請求頭
|
header |
必選 |
類型 |
說明 |
|
authorization |
是 |
string |
token |
請求參數(shù)
|
字段 |
類型 |
說明 |
|
id |
String |
歷史數(shù)據(jù)id |
3.2.3返回數(shù)據(jù)說明
|
字段 |
類型 |
說明 |
|
code |
int |
狀態(tài)碼 |
|
data |
Boolean |
是否成功 |
|
Message |
String |
異常信息 |
3.2.4返回格式示例
{
"code": 0,
"data": true,
"message": ""
}
3.3查詢實時數(shù)據(jù)
3.3.1接口描述
|
接口編號 |
3.1 |
|
接口名稱 |
查詢實時數(shù)據(jù) |
|
功能描述 |
查詢實時數(shù)據(jù) |
|
接口地址 |
/api/data/getRealTimeData |
|
請求方式 |
GET |
|
參數(shù)格式 |
JSON |
|
返回數(shù)據(jù)格式 |
JSON數(shù)組 |
|
備注 |
|
3.3.2請求參數(shù)說明
請求頭
|
header |
必選 |
類型 |
說明 |
|
authorization |
是 |
string |
token |
請求參數(shù)
|
字段 |
類型 |
說明 |
|
groupId |
String |
組編號 |
3.3.3返回數(shù)據(jù)說明
|
字段 |
類型 |
說明 |
|
code |
int |
狀態(tài)碼 |
|
data |
boolean |
是否成功 |
|
message |
String |
異常信息 |
|
nodeId |
int |
節(jié)點id |
|
alarmColor |
String |
報警顏色 |
|
alarmInfo |
String |
報警消息 |
|
alarmLevel |
int |
報警等級 |
|
data |
String |
數(shù)值 |
|
registerId |
int |
寄存器id |
|
unit |
String |
單位 |
|
value |
Double |
實際值 |
|
deviceAddr |
Integer |
設備地址碼 |
|
deviceName |
String |
設備名稱 |
|
deviceStatus |
String |
設備狀態(tài) |
|
Lat |
double |
緯度 |
|
Lng |
double |
經(jīng)度 |
|
relayStatus |
String |
繼電器狀態(tài) |
|
systemCode |
String |
系統(tǒng)編碼 |
|
timeStamp |
long |
時間戳 |
3.3.4返回格式示例
{
"code": 0,
"data": [
{
"dataItem": [
{
"nodeId": 0,
"registerItem": [
{
"alarmColor": "",
"alarmInfo": "",
"alarmLevel": 0,
"data": "",
"registerId": 0,
"unit": "",
"value": 0
}
]
}
],
"deviceAddr": 0,
"deviceName": "",
"deviceStatus": "",
"lat": 0,
"lng": 0,
"relayStatus": "",
"systemCode": "",
"timeStamp": 0
}
],
"message": ""
}
3.4根據(jù)設備地址查詢實時數(shù)據(jù)
3.4.1接口描述
|
接口編號 |
3.1 |
|
接口名稱 |
根據(jù)設備地址查詢實時數(shù)據(jù) |
|
功能描述 |
根據(jù)設備地址查詢實時數(shù)據(jù) |
|
接口地址 |
/api/data/getRealTimeDataByDeviceAddr |
|
請求方式 |
GET |
|
參數(shù)格式 |
JSON |
|
返回數(shù)據(jù)格式 |
JSON數(shù)組 |
|
備注 |
|
3.4.2請求參數(shù)說明
請求頭
|
header |
必選 |
類型 |
說明 |
|
authorization |
是 |
string |
token |
請求參數(shù)
|
字段 |
類型 |
說明 |
|
deviceAddrs |
String |
設備地址，多個用英文,分隔 |
3.4.3返回數(shù)據(jù)說明
|
字段 |
類型 |
說明 |
|
code |
int |
狀態(tài)碼 |
|
message |
String |
異常信息 |
|
nodeId |
int |
節(jié)點id |
|
alarmColor |
String |
報警顏色 |
|
alarmInfo |
String |
報警消息 |
|
alarmLevel |
int |
報警等級 |
|
data |
String |
數(shù)據(jù) |
|
registerId |
int |
寄存器id |
|
unit |
String |
單位 |
|
value |
double |
實際值 |
|
deviceAddr |
Integer |
設備地址碼 |
|
deviceName |
String |
設備名 |
|
deviceStatus |
String |
設備狀態(tài) |
|
lat |
double |
緯度 |
|
lng |
double |
經(jīng)度 |
|
relayStatus |
String |
繼電器狀態(tài) 0:斷開 1:開啟 |
|
systemCode |
String |
系統(tǒng)編碼 |
|
timeStamp |
long |
數(shù)據(jù)時間戳 |
3.4.4返回格式示例
{
"code": 0,
"data": [
{
"dataItem": [
{
"nodeId": 0,
"registerItem": [
{
"alarmColor": "",
"alarmInfo": "",
"alarmLevel": 0,
"data": "",
"registerId": 0,
"unit": "",
"value": 0
}
]
}
],
"deviceAddr": 0,
"deviceName": "",
"deviceStatus": "",
"lat": 0,
"lng": 0,
"relayStatus": "",
"systemCode": "",
"timeStamp": 0
}
],
"message": ""
}
三、附錄
返回代碼
|
代碼 |
說明 |
|
1000 |
接口執(zhí)行成功，具體參考各個接口 |
|
1001 |
接口執(zhí)行失敗，具體參考各個接口，原因參考Message |
|
1002 |
參數(shù)錯誤 |
|
1003 |
程序內(nèi)部異常，異常信息參考Message |
|
1004 |
鑒權失敗 |
0592-3564822
在線咨詢 9:00-18:00
排插式LoRa轉(zhuǎn)4G智能網(wǎng)關
無線遠程壓力采集終端
LoRaWAN無線遠程液位傳感器
無線智能消防栓水壓監(jiān)測
GNSS地質(zhì)災害監(jiān)測站
一體化傾斜伏倒檢測儀
地表裂縫監(jiān)測儀
無線4g傾斜傳感器(內(nèi)置電池)
衛(wèi)星物聯(lián)網(wǎng)傳輸數(shù)據(jù)采集主機
智能水位控制器
智能主機環(huán)境數(shù)據(jù)4G采集儀
S-CGC5低功耗溫濕度監(jiān)控
4G噴灌滴灌流量計
土壤熱流計熱通量傳感器
有線波載64路閥門集中控制器
S-PSVF 電池供電4G無線閥門控制
水位地災拍照雷達一體化水位
水中硼線上自動分析儀
水中鎳線上分析儀傳感器
水質(zhì)鉻自動分析儀傳感器
美麗鄉(xiāng)村水質(zhì)物聯(lián)網(wǎng)平臺
智能井蓋管理軟件平臺
S-DZJC監(jiān)測與預警服務平臺
負氧離子LED顯示發(fā)布系統(tǒng)
噪音揚塵監(jiān)測系統(tǒng)
太陽能供電電流電壓遠程監(jiān)控
超聲波風速風向,溫濕度,噪聲
水質(zhì)離子在線傳感器
