OpenAPI指南
權杖加密傳輸指南
本指南旨在詳細介紹如何在我們的開放平臺中安全地使用RSA加密演算法進行權杖（Token）的加密傳輸。 通過遵循本指南，您將能够確保敏感數據在用戶端與服務器之間的傳輸過程中得到最高級別的保護。
具體的操作詳見
令牌加密流程
- 生成金鑰對
開發者需要在中台應用中申請權杖，系統會生成金鑰對，開發者下載權杖資訊（資訊包含金鑰ID、金鑰Key和公開金鑰），下載資訊將用於加密權杖，私密金鑰則用於解密。 - 權杖申請，下載
1、进入设备管理
進入設備管理，操作詳見設備管理
2、權杖申請與下載
新增或下載權杖，操作詳見[權杖下載]（TokenManagement#權杖下載） - API说明
系統通過安全機制獲取的權杖（Token）資訊，利用RSA加密演算法進行加密處理，生成加密後的密文（Ciphertext）。 隨後，將此密文嵌入至API（應用程序介面）請求的HTTP頭部（Header）中，作為認證或授權資訊的一部分，進而發起API請求。 此過程確保了權杖資訊在傳輸過程中的機密性和安全性，防止了敏感資訊的洩露（加密方法可請參攷下麵示例代碼）。
示例代碼
JAVA示例檔案
Golang示例檔案
.Net示例檔案
常見請求錯誤碼
| 編碼 | 描述 |
|---|---|
| 401 | accesstoken過期，需要重新獲取 |
| 404 | 接口地址錯誤 |
| 428 | 用戶或租戶不存在 |
| 429 | 用戶未注册 |
| 500 | 服務器內部錯誤 |
| 503 | 服務忙，稍後重試 |
| 1000 | 數據***已存在 |
設備時序數據
設備時序數據推送
提示
可接入設備上報的時序數據，一次可推送多個設備，單次請求數據總數不可超過1000條
URL: /dataPlatform/openapi
HTTP請求管道: Post
請求體類型： 數組
身份驗證：請求頭欄位說明（加密方法詳見API調用Demo）
| 欄位名稱 | 欄位類型 | 是否必傳 | 位置 | 描述 |
|---|---|---|---|---|
| X-Source-SecretId | string | Header | 是 | 金鑰ID |
| X-Source-SecretKey | string | Header | 是 | 金鑰加密文字 |
數組單對象說明：
| 欄位名稱 | 欄位類型 | 是否必傳 | 描述 |
|---|---|---|---|
| time | string | 否 | 設備資料獲取時間 |
| equipmentName | string | 是 | 設備名稱 |
| functionType | string | 是 | 設備點比特名稱 |
| buildingName | string | 是 | 設備所在樓宇名稱（需同設備注册樓宇名稱一致） |
| devEui | string | 否 | IoT設備唯一標識 |
| value | double | 否 | 設備點比特數位類型值（value和reading二選一） |
| reading | string | 否 | 設備點位數字元類型值（value和reading二選一） |
| unit | string | 否 | 設備點比特組織 |
返回結果欄位說明
| 欄位名稱 | 欄位類型 | 描述 |
|---|---|---|
| code | int | 請求響應碼，200表示成功 |
| message | string | 系統消息 |
| isSuccess | boolean | 成功返回True，失敗返回False |
返回錯誤碼
詳見常見請求錯誤碼
設備詳情査詢
提示
可査詢單個設備詳情資訊
URL: /device/v1/mn/{devEui}
HTTP請求管道: Get
身份驗證：請求頭欄位說明（加密方法詳見API調用Demo）
| 欄位名稱 | 欄位類型 | 是否必傳 | 位置 | 描述 |
|---|---|---|---|---|
| X-Source-SecretId | string | Header | 是 | 金鑰ID |
| X-Source-SecretKey | string | Header | 是 | 金鑰加密文字 |
請求參數
| 欄位名稱 | 欄位類型 | 是否必傳 | 描述 |
|---|---|---|---|
| devEui | string | 是 | IoT设备唯一标识 |
返回結果欄位說明
| 欄位名稱 | 欄位類型 | 描述 |
|---|---|---|
| code | int | 請求響應碼，200表示成功 |
| message | string | 系統消息 |
| isSuccess | boolean | 成功 返回True，失敗返回False |
| data | object | 設備詳情對象 |
設備詳情data對象欄位說明
| 欄位名稱 | 描述 |
|---|---|
| name | 設備名稱 |
| alias | 設備別名 |
| equModel | 設備物模型 |
| points | 單個設備對應的設備點比特資訊（設備points下單個對象欄位說明） |
| devEUI | IoT設備唯一標識 |
| 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-SecretId | string | Header | 是 | 金鑰ID |
| X-Source-SecretKey | string | Header | 是 | 金鑰加密文字 |
請求參數
| 欄位名稱 | 欄位類型 | 是否必傳 | 描述 |
|---|---|---|---|
| current | int | 是 | 當前頁 |
| size | int | 是 | 每頁條數 |
| name | string | 否 | 設備名稱（模糊匹配） |
| devEui | string | 否 | IoT設備唯一標識（精確匹配） |
| buildingName | string | 否 | 設備註冊時填寫的樓宇名稱（精確匹配） |
| equModel | string | 否 | 設備物模型名稱（精確匹配） |
返回結果欄位說明
| 欄位名稱 | 欄位類型 | 描述 |
|---|---|---|
| code | int | 請求響應碼，200表示成功 |
| message | string | 系統消息 |
| isSuccess | boolean | 成功返回True，失敗返回False |
| data | object | 設備清單對象（total：總條數，size：每頁條數，current：當前頁，records：設備數據） |
設備數據records下單個對象欄位說明
| 欄位名稱 | 描述 |
|---|---|
| name | 設備名稱 |
| alias | 設備別名 |
| equModel | 設備物模型 |
| points | 單個設備對應的設備點比特資訊（設備points下單個對象欄位說明） |
| devEUI | IoT設備唯一標識 |
| location | 設備注册位置資訊 |
| isOnline | 設備是否線上（True表示線上，False表示離線） |
| descriptions | 設備描述 |
| isIot | 是否IoT設備（True是IoT設備，False非IoT設備） |
| buildingName | 設備注册樓宇名稱 |
設備points下單個對象欄位說明
| 欄位名稱 | 描述 |
|---|---|
| type | 設備點比特名稱 |
| unit | 設備點比特組織 |
| bmsId | 非IoT設備點比特ID |
| control | 是否支持反控（True可反控，False不可反控） |
返回錯誤碼
詳見常見請求錯誤碼
設備點比特最新值査詢
提示
可査詢當前租戶下可查看的所有設備資訊
URL: /device/v1/realtime/{devEui}/values
HTTP請求管道: Get
身份驗證：請求頭欄位說明（加密方法詳見API調用Demo）
| 欄位名稱 | 欄位類型 | 是否必傳 | 位置 | 描述 |
|---|---|---|---|---|
| X-Source-SecretId | string | Header | 是 | 金鑰ID |
| X-Source-SecretKey | string | Header | 是 | 金鑰加密文字 |
請求參數
| 欄位名稱 | 欄位類型 | 是否必傳 | 描述 |
|---|---|---|---|
| devEui | string | 否 | IoT設備唯一標識（精確匹配） |
返回結果欄位說明
| 欄位名稱 | 欄位類型 | 描述 |
|---|---|---|
| code | int | 請求響應碼，200表示成功 |
| message | string | 系統消息 |
| isSuccess | boolean | 成功返回True，失敗返回False |
| data | array | 設備點比特最新值 |
設備data數據中單個對象欄位說明
| 欄位名稱 | 描述 |
|---|---|
| time | 資料獲取時間 |
| equipmentName | 設備名稱 |
| buildingName | 設備注册樓宇資訊 |
| functionType | 單個設備點比特名稱 |
| devEUI | IoT設備唯一標識 |
| value | 設備數位類型值 |
| reading | 設備字元類型值 |
| unit | 設備點比特組織 |
返回錯誤碼
詳見常見請求錯誤碼
設備點比特歷史值査詢
提示
可査詢某個設備下單個或所有點比特的某段時間的數據值（時間區間僅可査詢一周內的數據）
URL: /device/v1/realtime/history
HTTP請求管道: Post
身份驗證：請求頭欄位說明（加密方法詳見API調用Demo）
| 欄位名稱 | 欄位類型 | 是否必傳 | 位置 | 描述 |
|---|---|---|---|---|
| X-Source-SecretId | string | Header | 是 | 金鑰ID |
| X-Source-SecretKey | string | Header | 是 | 金鑰加密文字 |
請求參數
| 欄位名稱 | 欄位類型 | 是否必傳 | 描述 |
|---|---|---|---|
| equipmentName | string | 是 | 設備名稱（精確匹配）） |
| functionType | string | 否 | 設備點比特名稱 |
| startTime | datatime | 否 | 開始時間 |
| endTime | datatime | 否 | 結束時間 |
| field | string | 是 | 設備點比特值類型（VALUE為數值型，READING為字元型） |
| equModel | string | 否 | 設備物模型名稱（精確匹配） |
返回結果欄位說明
| 欄位名稱 | 欄位類型 | 描述 |
|---|---|---|
| code | int | 請求響應碼，200表示成功 |
| message | string | 系統消息 |
| isSuccess | boolean | 成功返回True，失敗返回False |
| data | array | 設備點比特數值對象 |
設備data數組單個欄位說明
| 欄位名稱 | 描述 |
|---|---|
| time | 資料獲取時間 |
| equipmentName | 設備名稱 |
| buildingName | 設備注册樓宇資訊 |
| functionType | 單個設備點比特名稱 |
| devEUI | IoT設備唯一標識 |
| value | 設備數位類型值 |
| reading | 設備字元類型值 |
| unit | 設備點比特組織 |
返回 錯誤碼
詳見常見請求錯誤碼
數倉數據
數據推送
提示
可接入數据集數據（推送的欄位和資料類型需和數据集配寘對應），一次可推送多條（單次請求數據總數不可超過1000條）
URL: /dataset/v1/{datasetName}
HTTP請求管道: Post
身份驗證：請求頭欄位說明（加密方法詳見API調用Demo）
| 欄位名稱 | 欄位類型 | 是否必傳 | 位置 | 描述 |
|---|---|---|---|---|
| X-Source-SecretId | string | Header | 是 | 金鑰ID |
| X-Source-SecretKey | string | Header | 是 | 金鑰加密文字 |
請求體類型： 數組
請求參數
| 欄位名稱 | 欄位類型 | 是否必傳 | 描述 |
|---|---|---|---|
| datasetName | string | 是 | 數据集ID |
返回結果欄位說明
| 欄位名稱 | 欄位類型 | 描述 |
|---|---|---|
| code | int | 請求響應碼，200表示成功 |
| message | string | 系統消息 |
| isSuccess | boolean | 成功返回True，失敗返回False |
返回錯誤碼 |
詳見常見請求錯誤碼
資料查詢
提示
可査詢某個設備下單個或所有點比特的某段時間的數據值（時間區間僅可査詢一周內的數據）
URL: /device/v1/realtime/history
HTTP請求管道: Post
身份驗證：請求頭欄位說明（加密方法詳見API調用Demo）
| 欄位名稱 | 欄位類型 | 是否必傳 | 位置 | 描述 |
|---|---|---|---|---|
| X-Source-SecretId | string | Header | 是 | 金鑰ID |
| X-Source-SecretKey | string | Header | 是 | 金鑰加密文字 |
請求參數
| 欄位名稱 | 欄位類型 | 是否必傳 | 描述 |
|---|---|---|---|
| equipmentName | string | 是 | 設備名稱（精確匹配） |
| functionType | string | 否 | 設備點比特名稱 |
| startTime | datatime | 否 | 開始時間 |
| endTime | datatime | 否 | 結束時間 |
| field | string | 是 | 設備點比特值類型（VALUE為數值型，READING為字元型） |
| equModel | string | 否 | 設備物模型名稱（精確匹配） |
返回結果欄位說明
| 欄位名稱 | 欄位類型 | 描述 |
|---|---|---|
| code | int | 請求響應碼，200表示成功 |
| message | string | 系統消息 |
| isSuccess | boolean | 成功返回True，失敗返回False |
| data | array | 設備點比特數值對象 |
設備data數組單個欄位說明
| 欄位名稱 | 描述 |
|---|---|
| time | 資料獲取時間 |
| equipmentName | 設備名稱 |
| buildingName | 設備注册樓宇資訊 |
| functionType | 單個設備點比特名稱 |
| devEUI | IoT設備唯一標識 |
| value | 設備數位類型值 |
| reading | 設備字元類型值 |
| unit | 設備點比特組織 |
返回錯誤碼
詳見常見請求錯誤碼