【塗鴉物聯網足跡】塗鴉雲平臺接口列表

前序系列文章__>>>

【塗鴉物聯網足跡】塗鴉雲平臺接口說明

咱們系列文章，都會圍繞如何完成一款智能「隔空接吻機」的開發。但願能幫到各異地戀__or__異國戀的情侶們！

本文咱們會大概講解API接口列表~

接口列表及接口說明

受權管理

• 獲取訪問令牌：開發者經過開發平臺建立雲應用對應的受權憑證獲取令牌。
• 刷新用戶令牌：出於安全考慮，當前每一個 OAuth token 的有效期爲兩小時，過時之後須要使用 refresh_token 來換取新的令牌。

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

• 免登陸令牌：根據塗鴉用戶uid生成免登陸令牌，部分場景或者API接口須要使用此令牌進行請求。

用戶管理

• 同步用戶：該接口爲帳號同步接口，您可結合本身的業務場景，根據不一樣參數來完成帳號建立和帳號信息修改。

1. 在同一應用下，傳入相同用戶名，則會更新該用戶上一次的用戶信息。
2. 如需在塗鴉 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，可分爲循環定時任務與非循環定時任務。

1. 循環定時：以一週爲循環，可設定週一到週日的循環定時。

2. 非循環定時：設定指定時間節點的定時任務，接口會對設定的時間節點作限定。該時間節點須要在當前時間以後，不然沒法建立定時任務，並提示定時任務已過時。

   • 查詢設備下的定時任務列表：該接口用於查詢指定設備 ID 下已添加定時任務的詳細信息列表。
   • 獲取設備某一個分類下⾯的定時任務信息：該接口用於獲取指定設備下某⼀個分類下⾯的定時任務信息。
   • 更新設備的某⼀個定時任務組的信息：該接口用於更新設備的某一個定時任務組的信息。
   • 更新/獲取設備定時任務組的狀態：該接口用於更新/獲取設備定時任務組的狀態。
   • 建立/更新羣組定時任務：該接口用於建立/更新羣組定時任務。

​​​​​​​全屋管理

• 添加家庭：給⽤戶添加⼀個家庭以及家庭下的房間。
• 修改家庭：修改家庭基礎信息。
• 刪除/查詢家庭：根據家庭ID刪除/查詢家庭。
• 查詢家庭下的設備詳情：根據家庭 ID查詢家庭下的設備列表。
• 添加房間：根據家庭ID添加房間
• 修改/刪除/查詢房間：根據家庭 ID 和房間 ID 修改/刪除/查詢房間。
• 添加家庭成員：給某個家庭添加家庭成員。
• 設置成員權限：爲家庭成員設置管理員和非管理員的角色權限，修改家庭成員的名字。
• 刪除/查詢家庭成員：刪除/查詢某個家庭下成員。
• 查詢⽤戶所在的家庭列表：根據 uid 查詢⽤戶所在的家庭列表。
• 查詢/新增/修改/刪除家庭下房間內的設備：查詢/新增/修改/刪除家庭下房間內的設備。

場景自動化

• 查詢家庭下的場景列表：查詢家庭下的場景列表。
• 查詢默認場景圖片列表：查詢默認場景圖⽚列表。
• 觸發/添加/刪除/修改場景：觸發執/添加/刪除/修改行某個場景。
• 查詢家庭下支持場景的設備列表：查詢家庭下支持場景的設備列表。
• 場景綁定/綁定：接口主要適用於場景開關設備。場景開關有相應的開關按鈕，每一個開關按鈕擁有相應的指令。經過該接口，能夠將指定的開關指令與場景進行綁定，即場景開關與場景進行關聯操做。綁定成功後，經過指令下發接口，能夠直接觸發場景。
• 場景解綁：接口主要適用於場景開關設備。場景開關中的某個開關與指定場景綁定後，可經過該接口進行解綁。
• 查詢設備已綁定的場景列表：接口主要適用於場景開關設備。經過場景開關設備 ID，查詢該設備所關聯的場景列表。
• 添加/修改/刪除自動化：爲家庭添加/修改/刪除自動化功能。
• 查詢自動化列表：查詢自動化列表。
• 查詢單個自動化：查詢家庭中單個自動化場景。
• 觸發自動化外部條件：觸發家庭中自動化場景的外部條件。
• 查詢支持自動化場景的設備列表：查詢家庭下支持自動化場景的設備列表。
• 查詢自動化場景支持的天氣條件：查詢自動化支持的天氣條件。
• 獲取家庭支持的聯動條件：根據家庭 ID 獲取聯動條件或執行動做的標準功能點。
• 獲取設備支持的聯動條件：根據設備 ID 獲取聯動條件或執行動做的標準功能點。
• 啓用/停用自動化：啓用/停用自動化場景。

數據服務

• 獲取數據整體概況：獲取數據整體概況。
• 統計 App 日註冊用戶數：統計 App 日註冊用戶數。
• 統計 App 日活躍用戶數：統計 App 日活躍用戶數。
• 獲取 App 設備數據概況：獲取 App 設備數據概況。
• 獲取設備整體概況：獲取設備整體概況。
• 獲取活躍設備地區分佈數據：獲取活躍設備地區分佈數據。
• 獲取激活設備地區分佈詳情數據：獲取激活設備地區分佈詳情數據。
• 統計設備日活躍數/激活數/共激活數據：統計設備日活躍數/激活數/共激活數據。
• 獲取設備活躍數據概況：獲取設備活躍數據概況。
• 獲取歷史累計值：獲取歷史累計值。
• 獲取設備支持的統計類型：查詢設備當前支持的統計類型。
• 按小時/天/星期/月統計：以小時/天/周/月爲單位，返回設備近 7 天的統計數據。

天氣服務

• 查詢城市列表：根據國家碼獲取該國支持天氣數據城市的信息。
• 查詢城市信息：根據城市ID來查詢城市信息。
• 根據經緯度查詢城市列表：根據經緯度查詢城市列表。
• 查詢城市天氣預報：根據城市 ID查詢天氣預報。
• 根據IP查詢天氣預報：根據城市 IP 查詢天氣預報。
• 根據經緯度查詢天氣：根據城市經緯度來查詢城市的天氣信息。
• 查詢城市當前天氣狀況：根據城市ID查詢城市當每天氣狀況。

設備管理

• 獲取設備詳情：可查詢設備的詳情信息，包括設備屬性和設備最新狀態。
• 獲取用戶下設備列表：可查詢用戶下可操做的設備列表，包括設備屬性、設備最新狀態。

• 獲取設備列表：提供按應用、產品、設備 ID 查詢設備列表的能力，調用該接口時，建議請求參數三選一。數據權限維度知足如下任意一種，則可獲取相關設備數據：

  1. 應用維度：應用維度針對於設備採購商。設備採購商經過將應用（在塗鴉平臺建立的 OEM App 或者基於塗鴉的客戶端 SDK 自行開發）綁定設備的方式來獲取設備的數據。
  2. 產品維度：產品維度針對於設備生產廠商。生產廠商經過在塗鴉平臺建立產品，而後基於這個產品來生產設備（設備鏈接塗鴉雲），最終獲取或管控廠商所生產設備的數據。
• 修改功能點名稱：知足多路子設備，能夠進行子設備名稱修改。
• 查詢設備日誌：根據查詢條件查詢設備操做歷史記錄。
• 恢復設備出廠設置：根據設備 ID 來恢復出廠設置。
• 移除設備：根據設備 ID 來移除設備。
• 查詢網關下的設備列表：查詢網關下的設備列表。
• 查詢設備出廠信息：查詢設備出廠信息。
• 修改設備名稱：修改設備名稱。
• 修改多路名稱：當設備存在多路名稱時可修改，現支持排插類設備。

OTA升級

• 獲取設備的升級信息：獲取設備的升級信息。
• 確認設備升級：確認設備升級。

設備羣組

• 查詢設備羣組列表
• 查詢羣組詳情
• 查詢羣組列表
• 建立設備羣組
• 修改羣組分組
• 刪除羣組分組
• 給設備羣組下發指令