「塗鴉物聯網足跡」塗鴉雲平臺介面列表

介面列表及介面說明

授權管理

獲取訪問令牌：開發者透過開發平臺建立雲應用對應的授權憑證獲取令牌。

重新整理使用者令牌：出於安全考慮，當前每個 OAuth token 的有效期為兩小時，過期以後需要使用 refresh_token 來換取新的令牌。

說明

：access_token 有時間限制，無次數限制；而 refresh_token 無時間限制，但是隻能生效一次。

免登入令牌：根據塗鴉使用者uid生成免登入令牌，部分場景或者API介面需要使用此令牌進行請求。

使用者管理

同步使用者：該介面為賬號同步介面，您可結合自己的業務場景，根據不同引數來完成賬號建立和賬號資訊修改。

在同一應用下，傳入相同使用者名稱，則會更新該使用者上一次的使用者資訊。

如需在塗鴉 OEM App 中直接使用，OEM App 當前僅支援手機號和郵箱地址，且密碼 hash 規則為 MD5 演算法。

獲取使用者列表：您在塗鴉 IoT 平臺建立的應用關聯到的使用者資料，可透過該 API 完成拉取。考慮到使用者隱私安全，針對使用者個人隱私欄位，將進行加密處理。

獲取使用者資訊：用來獲取使用者資訊。

配網管理

：隨著產品配網方式豐富度的提高，雲開發平臺對主流配網能力進行了迭代，提供了許可權管理介面來滿足不同配網方式的訴求，例如 Wi-Fi 配網、藍芽配網、藍芽 + Wi-Fi 雙模配網等方式。

生成配網令牌：發現裝置之前，需要先申請一個臨時令牌，經過塗鴉客戶端 SDK 進行配網，裝置接到配網令牌後可自動完成發現和賬號繫結。當前支援 Wi-Fi 配網和 BLE + Wi-Fi 配網方式，更多能力持續拓展中（BLE 裝置需掃描裝置二維碼獲取裝置唯一 ID 用於配網）。

輪詢配網結果：由於裝置配網是一個非同步流程，根據網路質量的不同，裝置成功入網的時間不定，故需要開發者輪詢該介面直至查詢到裝置列表或到超時停止輪詢（輪詢週期為 1 秒一次，超時時間建議為 100 秒）。

開放閘道器允許子裝置入網：由於子裝置不具備直接的聯網能力，故而新增子裝置需要閘道器加入。閘道器進入允許入網狀態後，子裝置可以加入閘道器的本地網路，透過閘道器完成入庫。

獲取入網子裝置列表：子裝置配網是一個非同步流程，配網時會根據裝置數量以及網路情況陸續將子裝置加入閘道器。因此需要根據初次發現時間輪詢此介面獲取子裝置列表，可結合自身業務結束髮現流程，建議每次輪詢 1 秒直至 100 秒結束。

獲取閘道器下的子裝置列表：透過閘道器裝置 ID，獲取子裝置列表。

裝置控制

獲取指令集（按品類）：按品類來查詢指令集，該指令集為塗鴉公版品類下最豐富的指令集，可供開發者參考使用。如果是平臺類開發者，建議可按照此類進行開發對接。

獲取指令集（按裝置）：查詢裝置支援的功能，獲取到的指令可用於下發控制。

獲取裝置規格屬性（包含指令集、狀態集）：根據裝置 ID 獲取裝置支援的指令集和狀態集。

下發裝置指令：根據獲取到的指令集，可按一組或多組指令集進行下發，是否同時支援多指令同時執行依具體產品而定。

獲取裝置最新狀態：根據裝置 ID 來查詢裝置最新狀態。

定時管理

裝置新增定時任務：該介面為裝置新增定時任務。透過引數 loops，可分為迴圈定時任務與非迴圈定時任務。

迴圈定時：以一週為迴圈，可設定週一到週日的迴圈定時。

非迴圈定時：設定指定時間節點的定時任務，介面會對設定的時間節點做限定。該時間節點需要在當前時間之後，否則無法建立定時任務，並提示定時任務已過期。

查詢裝置下的定時任務列表：該介面用於查詢指定裝置 ID 下已新增定時任務的詳細資訊列表。

獲取裝置某一個分類下的定時任務資訊：該介面用於獲取指定裝置下某個分類下的定時任務資訊。

更新裝置的某個定時任務組的資訊：該介面用於更新裝置的某一個定時任務組的資訊。

更新/獲取裝置定時任務組的狀態：該介面用於更新/獲取裝置定時任務組的狀態。

建立/更新群組定時任務：該介面用於建立/更新群組定時任務。

全屋管理

新增家庭：給戶添加個家庭以及家庭下的房間。

修改家庭：修改家庭基礎資訊。

刪除/查詢家庭：根據家庭ID刪除/查詢家庭。

查詢家庭下的裝置詳情：根據家庭 ID查詢家庭下的裝置列表。

新增房間：根據家庭ID新增房間

修改/刪除/查詢房間：根據家庭 ID 和房間 ID 修改/刪除/查詢房間。

新增家庭成員：給某個家庭新增家庭成員。

設定成員許可權：為家庭成員設定管理員和非管理員的角色許可權，修改家庭成員的名字。

刪除/查詢家庭成員：刪除/查詢某個家庭下成員。

查詢戶所在的家庭列表：根據 uid 查詢戶所在的家庭列表。

查詢/新增/修改/刪除家庭下房間內的裝置：查詢/新增/修改/刪除家庭下房間內的裝置。

場景自動化

查詢家庭下的場景列表：查詢家庭下的場景列表。

查詢預設場景圖片列表：查詢預設場景圖列表。

觸發/新增/刪除/修改場景：觸發執/新增/刪除/修改行某個場景。

查詢家庭下支援場景的裝置列表：查詢家庭下支援場景的裝置列表。

場景繫結/繫結：介面主要適用於場景開關裝置。場景開關有相應的開關按鈕，每個開關按鈕擁有相應的指令。透過該介面，可以將指定的開關指令與場景進行繫結，即場景開關與場景進行關聯操作。繫結成功後，透過指令下發介面，可以直接觸發場景。

場景解綁：介面主要適用於場景開關裝置。場景開關中的某個開關與指定場景繫結後，可透過該介面進行解綁。

查詢裝置已繫結的場景列表：介面主要適用於場景開關裝置。透過場景開關裝置 ID，查詢該裝置所關聯的場景列表。

新增/修改/刪除自動化：為家庭新增/修改/刪除自動化功能。

查詢自動化列表：查詢自動化列表。

查詢單個自動化：查詢家庭中單個自動化場景。

觸發自動化外部條件：觸發家庭中自動化場景的外部條件。

查詢支援自動化場景的裝置列表：查詢家庭下支援自動化場景的裝置列表。

查詢自動化場景支援的天氣條件：查詢自動化支援的天氣條件。

獲取家庭支援的聯動條件：根據家庭 ID 獲取聯動條件或執行動作的標準功能點。

獲取裝置支援的聯動條件：根據裝置 ID 獲取聯動條件或執行動作的標準功能點。

啟用/停用自動化：啟用/停用自動化場景。

資料服務

獲取資料總體概況：獲取資料總體概況。

統計 App 日註冊使用者數：統計 App 日註冊使用者數。

統計 App 日活躍使用者數：統計 App 日活躍使用者數。

獲取 App 裝置資料概況：獲取 App 裝置資料概況。

獲取裝置總體概況：獲取裝置總體概況。

獲取活躍裝置地區分佈資料：獲取活躍裝置地區分佈資料。

獲取啟用裝置地區分佈詳情資料：獲取啟用裝置地區分佈詳情資料。

統計裝置日活躍數/啟用數/共啟用資料：統計裝置日活躍數/啟用數/共啟用資料。

獲取裝置活躍資料概況：獲取裝置活躍資料概況。

獲取歷史累計值：獲取歷史累計值。

獲取裝置支援的統計型別：查詢裝置當前支援的統計型別。

按小時/天/星期/月統計：以小時/天/周/月為單位，返回裝置近 7 天的統計資料。

天氣服務

查詢城市列表：根據國家碼獲取該國支援天氣資料城市的資訊。

查詢城市資訊：根據城市ID來查詢城市資訊。

根據經緯度查詢城市列表：根據經緯度查詢城市列表。

查詢城市天氣預報：根據城市 ID查詢天氣預報。

根據IP查詢天氣預報：根據城市 IP 查詢天氣預報。

根據經緯度查詢天氣：根據城市經緯度來查詢城市的天氣資訊。

查詢城市當前天氣情況：根據城市ID查詢城市當天天氣情況。

裝置管理

獲取裝置詳情：可查詢裝置的詳情資訊，包括裝置屬性和裝置最新狀態。

獲取使用者下裝置列表：可查詢使用者下可操作的裝置列表，包括裝置屬性、裝置最新狀態。

獲取裝置列表：提供按應用、產品、裝置 ID 查詢裝置列表的能力，呼叫該介面時，建議請求引數三選一。資料許可權維度滿足以下任意一種，則可獲取相關裝置資料：

應用維度：應用維度針對於裝置採購商。裝置採購商透過將應用（在塗鴉平臺建立的 OEM App 或者基於塗鴉的客戶端 SDK 自行開發）繫結裝置的方式來獲取裝置的資料。

產品維度：產品維度針對於裝置生產廠商。生產廠商透過在塗鴉平臺建立產品，然後基於這個產品來生產裝置（裝置連線塗鴉雲），最終獲取或管控廠商所生產裝置的資料。

修改功能點名稱：滿足多路子裝置，可以進行子裝置名稱修改。

查詢裝置日誌：根據查詢條件查詢裝置操作歷史記錄。

恢復裝置出廠設定：根據裝置 ID 來恢復出廠設定。

移除裝置：根據裝置 ID 來移除裝置。

查詢閘道器下的裝置列表：查詢閘道器下的裝置列表。

查詢裝置出廠資訊：查詢裝置出廠資訊。

修改裝置名稱：修改裝置名稱。

修改多路名稱：當裝置存在多路名稱時可修改，現支援排插類裝置。

OTA升級

獲取裝置的升級資訊：獲取裝置的升級資訊。

確認裝置升級：確認裝置升級。

裝置群組

查詢裝置群組列表

查詢群組詳情

查詢群組列表

建立裝置群組

修改群組分組

刪除群組分組

給裝置群組下發指令