平台提供開放的API介面,用戶可以通過HTTP / HTTPS 調用(推薦使用HTTPS),進行設備管理,數據查詢,設備命令交互等操作,在API的基礎上,根據自己的個人需求搭建上層應用
API地址為:api.onenet.hk.chinamobile.com
為提高API訪問安全性,OneNET API的鑒權參數作為header參數存在
MQTT物聯網套件中以accessKey為核心金鑰,用戶需要使用核心金鑰通過簽名演算法計算簽名,與其他參數共同組成token,然後將token作為請求Header參數進行鑒權,見token演算法
token 示例如下:
(以“查詢設備詳情API”為例)
API返回內容中,HTTP狀態碼進行如下分類:
HTTP狀態碼 | 狀態碼說明 |
---|---|
2xx | 執行成功 |
4xx | 用戶端的錯誤,通常情況下用戶端需要修改請求然後再次發送請求 |
5xx | 服務端的錯誤 |
API返回內容如下所示:
其中,固定參數說明如下:
參數 | 參數說明 |
---|---|
request_id | 平台為每次請求分配的唯一ID |
code_no | 錯誤碼 |
code | 錯誤碼說明 |
message | 錯誤碼詳情 |
data | 請求返回數據內容 |
錯誤碼相關說明,請見錯誤碼詳情