跳至主要内容

OpenAPI 指南

令牌加密傳輸指南

本指南旨在詳細介紹如何在我們的開放平台中安全地使用 RSA 加密算法進行令牌(Token)的加密傳輸。通過遵循本指南,您將能夠確保敏感數據在客戶端與伺服器之間的傳輸過程中得到最高級別的保護。

令牌加密流程

  • 生成密鑰對
    開發者需要在中台應用中申請令牌,系統會生成密鑰對。開發者下載令牌信息(信息包含密鑰 ID、密鑰 Key 和公鑰),這些信息將用於加密令牌,私鑰則用於解密。
  • 令牌申請與下載
    1. 進入設備管理
      操作詳見 設備管理
    2. 令牌申請與下載
      新增或下載令牌,操作詳見 令牌下載
  • API 接口說明
    系統通過安全機制獲取的令牌(Token)信息,利用 RSA 加密算法進行加密處理,生成加密後的密文(Ciphertext)。隨後,將此密文嵌入至 API(應用程式接口)請求的 HTTP 頭部(Header)中作為認證或授權信息的一部分,進而發起 API 請求。此過程確保令牌信息在傳輸過程中的機密性和安全性,防止敏感信息的洩露(加密方法參考示例代碼)。

示例代碼

JAVA 示例文件

Golang 示例文件

.Net 示例文件

常見請求錯誤碼

編碼描述
401accesstoken 過期,需要重新獲取
404接口地址錯誤
428用戶或租戶不存在
429用戶未註冊
500伺服器內部錯誤
503服務繁忙,稍後重試
1000數據***已存在

設備時序數據

設備時序數據推送

提示

可接入設備上報的時序數據,一次可推送多個設備,單次請求數據總數不可超過 1000 條

URL: /dataPlatform/openapi

HTTP 請求方式: POST

請求體類型: 數組

身份驗證: 請求頭字段說明(加密方法詳見 API 調用 Demo

字段名稱字段類型是否必傳位置描述
X-Source-SecretIdstringHeader密鑰 ID
X-Source-SecretKeystringHeader密鑰加密文本

數組單對象說明

字段名稱字段類型是否必傳描述
timestring設備數據採集時間
equipmentNamestring設備名稱
functionTypestring設備點位名稱
buildingNamestring設備所在樓宇名稱(需同設備註冊樓宇名稱一致)
devEuistringIoT 設備唯一標識
valuedouble設備點位數字類型值(valuereading 二選一)
readingstring設備點位字符類型值(valuereading 二選一)
unitstring設備點位單位

返回結果字段說明

字段名稱字段類型描述
codeint請求響應碼,200 表示成功
messagestring系統消息
isSuccessboolean成功返回 True,失敗返回 False

返回錯誤碼

詳見常見請求錯誤碼

設備詳情查詢

提示

可查詢單個設備的詳細信息。

URL: /device/v1/mn/{devEui}

HTTP 請求方式: GET

身份驗證: 請求頭字段說明(加密方法詳見 API 調用 Demo

字段名稱字段類型是否必傳位置描述
X-Source-SecretIdstringHeader密鑰 ID
X-Source-SecretKeystringHeader密鑰加密文本

請求參數

字段名稱字段類型是否必傳描述
devEuistringIoT 設備唯一標識

返回結果字段說明

字段名稱字段類型描述
codeint請求響應碼,200 表示成功
messagestring系統消息
isSuccessboolean成功返回 True,失敗返回 False
dataobject設備詳情對象

設備詳情 data 對象字段說明

字段名稱描述
name設備名稱
alias設備別名
equModel設備物模型
points單個設備的功能點列表(詳見下方字段說明)
devEUIIoT 設備唯一標識
location設備註冊位置
isOnline設備是否在線(True 為在線,False 為離線)
descriptions設備描述
isIot是否為 IoT 設備(True 是 IoT 設備,False 為非 IoT 設備)
buildingName設備註冊樓宇名稱

設備點位 points 單個對象字段說明

字段名稱描述
type設備點位名稱
unit設備點位單位
bmsId非 IoT 設備點位 ID
control是否支持反控(True 支持,False 不支持)

返回錯誤碼

詳見常見請求錯誤碼

設備列表查詢

提示

可查詢當前租戶下所有設備的信息。

URL: /device/v1/mn/page

HTTP 請求方式: GET

身份驗證: 請求頭字段說明(加密方法詳見 API 調用 Demo

字段名稱字段類型是否必傳位置描述
X-Source-SecretIdstringHeader密鑰 ID
X-Source-SecretKeystringHeader密鑰加密文本

請求參數

字段名稱字段類型是否必傳描述
currentint當前頁碼
sizeint每頁條數
namestring設備名稱(模糊匹配)
devEuistringIoT 設備唯一標識(精確匹配)
buildingNamestring設備註冊樓宇名稱(精確匹配)
equModelstring設備物模型名稱(精確匹配)

返回結果字段說明

字段名稱字段類型描述
codeint請求響應碼,200 表示成功
messagestring系統消息
isSuccessboolean成功返回 True,失敗返回 False
dataobject設備列表對象(包括總條數、每頁條數等)

設備列表 records 下單個對象字段說明

字段名稱描述
name設備名稱
alias設備別名
equModel設備物模型
points設備的功能點列表(詳見設備點位說明
devEUIIoT 設備唯一標識
location設備註冊位置
isOnline設備是否在線
descriptions設備描述
isIot是否 IoT 設備
buildingName設備註冊樓宇名稱

設備 points 單個對象字段說明

字段名稱描述
type設備點位名稱
unit設備點位單位
bmsId非 IoT 設備點位 ID
control是否支持反控(True 可反控,False 不可反控)

返回錯誤碼

詳見常見請求錯誤碼

設備點位最新值查詢

提示

可查詢指定設備的點位最新值。

URL: /device/v1/realtime/{devEui}/values

HTTP 請求方式: GET

身份驗證: 請求頭字段說明(加密方法詳見 API 調用 Demo

字段名稱字段類型是否必傳位置描述
X-Source-SecretIdstringHeader密鑰 ID
X-Source-SecretKeystringHeader密鑰加密文本

請求參數

字段名稱字段類型是否必傳描述
devEuistringIoT 設備唯一標識(精確匹配)

返回結果字段說明

字段名稱字段類型描述
codeint請求響應碼,200 表示成功
messagestring系統消息
isSuccessboolean成功返回 True,失敗返回 False
dataarray設備點位最新值列表

設備點位最新值 data 單個對象字段說明

字段名稱描述
time數據采集時間
equipmentName設備名稱
buildingName設備註冊樓宇信息
functionType單個設備點位名稱
devEUIIoT 設備唯一標識
value數字類型點位的值
reading字符串類型點位的值
unit設備點位單位

返回錯誤碼

詳見常見請求錯誤碼

設備點位歷史值查詢

提示

可查詢指定設備在某段時間內的點位歷史數據值(時間區間僅支持一週內的數據)。

URL: /device/v1/realtime/history

HTTP 請求方式: POST

身份驗證: 請求頭字段說明(加密方法詳見 API 調用 Demo

字段名稱字段類型是否必傳位置描述
X-Source-SecretIdstringHeader密鑰 ID
X-Source-SecretKeystringHeader密鑰加密文本

請求參數

字段名稱字段類型是否必傳描述
equipmentNamestring設備名稱(精確匹配)
functionTypestring點位名稱
startTimedatetime起始時間
endTimedatetime結束時間
fieldstring點位值類型(VALUE 為數值型,READING 為字符型)
equModelstring設備物模型名稱(精確匹配)

返回結果字段說明

字段名稱字段類型描述
codeint請求響應碼,200 表示成功
messagestring系統消息
isSuccessboolean成功返回 True,失敗返回 False
dataarray設備點位歷史數據列表

設備點位歷史值 data 單個對象字段說明

字段名稱描述
time數據采集時間
equipmentName設備名稱
buildingName設備註冊樓宇信息
functionType單個設備點位名稱
devEUIIoT 設備唯一標識
value數字類型點位的值
reading字符串類型點位的值
unit設備點位單位

返回錯誤碼

詳見常見請求錯誤碼

數倉數據

數據推送

提示

可接入數據集數據(推送的字段和數據類型需和數據集配置對應),一次可推送多條(單次請求數據總數不可超過1000條)

URL: /dataset/v1/{datasetName}

HTTP請求方式: Post

身份驗證: 請求頭字段說明(加密方法詳見API調用Demo

字段名稱字段類型是否必傳位置描述
X-Source-SecretIdstringHeader密鑰ID
X-Source-SecretKeystringHeader密鑰加密文本
X-Param-ProjectIdstringHeader平台項目ID

請求體類型: 數組

請求參數

字段名稱字段類型是否必傳描述
datasetNamestring數據集ID

返回結果字段說明

字段名稱字段類型描述
codeint請求響應碼,200表示成功
messagestring系統消息
isSuccessboolean成功返回True, 失敗返回False

返回錯誤碼

詳見請求錯誤碼

數據查詢

提示

可查詢某個設備下單個或所有點位的某段時間的數據值(時間區間僅可查詢一周內的數據)

URL: /device/v1/realtime/history

HTTP請求方式: Post

身份驗證: 請求頭字段說明(加密方法詳見API調用Demo

字段名稱字段類型是否必傳位置描述
X-Source-SecretIdstringHeader密鑰ID
X-Source-SecretKeystringHeader密鑰加密文本
X-Param-ProjectIdstringHeader平台項目ID

請求參數

字段名稱字段類型是否必傳描述
equipmentNamestring設備名稱(精確匹配)
functionTypestring設備點位名稱
startTimedatatime開始時間
endTimedatatime結束時間
fieldstring設備點位值類型(VALUE為數值型,READING為字符型)
equModelstring設備物模型名稱(精確匹配)

返回結果字段說明

字段名稱字段類型描述
codeint請求響應碼,200表示成功
messagestring系統消息
isSuccessboolean成功返回True, 失敗返回False
dataarray設備點位數值對象

設備data數組單個字段說明

字段名稱描述
time數據采集時間
equipmentName設備名稱
buildingName設備註冊樓宇信息
functionType單個設備點位名稱
devEUIIoT設備唯一標識
value設備數字類型值
reading設備字符類型值
unit設備點位單位

返回錯誤碼

詳見請求錯誤碼