Nest API 參考資料

Nest API 會將實體住家或建築物建立為住家結構體,住家中的 Nest Learning Learning Thermostat、Nest Protect 和 Nest Cam 都是裝置。 此外,這個結構也包含住家的整體相關資訊 (例如外出或預計到達時間,或是尖峰時段)。

結構中的每一個資料元素都可以透過共用 JSON 文件中的資源網址 (稱為「資料位置」) 來定址。每個資料位置都可以儲存字串、數字、布林值、父項/子項物件或陣列。

透過這個互動式 API 參考資料探索資料模型。

您可以透過 API 同步處理資料模型中不同層級的位置,例如:

  • 整個架構,包括所有裝置
  • 結構中的單一裝置
  • 一組資料值 (目前和環境溫度)
  • 單一資料值 (電池狀態)

產品應妥善回應下列活動:

但請記住,每個裝置型物件在實際限制下都能運作。舉例來說,當緊急加熱功能啟用時,溫度控制器不應執行空調。我們的 API 主要是用於保護裝置和使用者的住家,因此若使用者會感到意外或危險,便會採取某些行動。

權限和共用裝置資料

讀取或寫入資料位置的功能是由權限所控制。 權限群組可針對裝置和結構中的特定資料值,提供讀取、寫入或讀取/寫入權限。

詳情請參閱權限總覽

資料和隱私權

與居家產品相關的資料可能相當個人化。居家感應器資料 內含個人生活在個人空間中的相關資訊。 這些資料的安全性和處理極為重要,Nest 平台的一大重點並讓使用者明確知道我們收集的資料類型、資料的使用方式,以及可以控制的地方。

進一步瞭解我們對於隱私權的看法

中繼資料

中繼資料是您在呼叫根層級端點時所提供的額外資訊:

https://developer-api.nest.com/

access_token

使用者授權之後,產品會使用存取憑證來向 Nest 服務發出 API 呼叫。此存取憑證可當做證明,您已授權使用者代為使用產品進行通話。

詳情
退貨string
例如:「c.FmDPkzyzaQe..."

client_version

用戶端版本是用戶端的最終使用者授權版本,且與 access_token 相關聯。

當您更新用戶端的權限時,用戶端版本會遞增,並通知使用者有可用的更新。使用者必須接受這項用戶端更新,才能使用更新的產品。

詳情
退貨number
示例:1、17、42

user_id

使用者 ID 可讓您識別各項 API 呼叫中的使用者。每個 Works with Nest 產品和使用者組合的 ID 都會有所不同。

舉例來說,假設使用者 1 已授權使用 Works with Nest 產品 A 和 Works with Nest 產品 B,那麼產品 A 具有使用者 1 的 user_id 值,產品 B 則是使用者 1 的 user_id 值。

詳情
退貨string
範例:z.1.1.7DHps...