Nest API modeluje fizyczny dom lub budynek jako strukturę, z termostatami Nest Learning, Nest Protects i Nest Cams jako urządzeniami w strukturze. Ta struktura zawiera również informacje o domu jako całości (takie jak stan Poza domem lub ETA lub aktywne godziny szczytu).
Każdy element danych w strukturze można adresować za pomocą adresu URL zasobu (zwanego „lokalizacją danych”) we współdzielonym dokumencie JSON. Każda lokalizacja danych może przechowywać łańcuchy, liczby, wartości logiczne, obiekty nadrzędne / podrzędne lub tablice.
Eksploruj model danych za pomocą tego interaktywnego interfejsu API .
Za pomocą interfejsu API możesz synchronizować dane z lokalizacji na wielu poziomach modelu danych, na przykład:
- całą strukturę, w tym wszystkie urządzenia
- pojedyncze urządzenie w strukturze
- grupa wartości danych (aktualna i temperatura otoczenia)
- pojedyncza wartość danych (stan baterii)
Twoje produkty powinny rozsądnie reagować na takie zdarzenia:
- obecność (w domu i poza domem)
- bezpieczeństwo (dym i tlenek węgla)
- zużycie energii w drogich porach dnia
- wydarzenia (dźwięk i ruch)
Należy jednak pamiętać, że każdy z obiektów opartych na urządzeniach działa w warunkach rzeczywistych. Na przykład termostat nie powinien uruchamiać klimatyzatora, gdy włączone jest ogrzewanie awaryjne. Nasze API zostało zaprojektowane w celu ochrony zarówno naszych urządzeń, jak i domu użytkownika, i zapobiega niektórym działaniom, jeśli byłyby zaskakujące lub niebezpieczne.
Uprawnienia i udostępnione dane urządzenia
Możliwość odczytu lub zapisu w lokalizacji danych jest kontrolowana przez uprawnienia. Grupy uprawnień zapewniają dostęp do odczytu, zapisu lub odczytu / zapisu wybranych wartości danych w urządzeniach i strukturach.
Aby uzyskać więcej informacji, zobacz Omówienie uprawnień .
Dane i prywatność
Dane związane z produktami do użytku domowego mogą być bardzo osobiste. Dane czujnika domu zawierają informacje o tym, jak ludzie żyją w swojej przestrzeni osobistej. Bezpieczeństwo i obsługa tych danych jest bardzo ważna i kładzie duży nacisk na Nest. Dajemy użytkownikom jasne do zrozumienia, jakie dane posiadamy, w jaki sposób są używane i gdzie mogą nimi sterować.
Dowiedz się więcej o naszych poglądach na temat prywatności .
Metadane
Metadane to dodatkowe informacje, które są dostarczane podczas wywołania punktu końcowego poziomu głównego:
https://developer-api.nest.com/
access_token
Po autoryzacji użytkownika produkt używa tokena dostępu do wykonywania wywołań API do usługi Nest. Ten token dostępu służy jako dowód, że użytkownik autoryzował Twój produkt do wykonywania połączeń w jego imieniu.
| Detale | |
|---|---|
| Zwroty | string Przykład: „c.FmDPkzyzaQe ...” |
wersja_klienta
Wersja klienta to ostatnia wersja klienta autoryzowana przez użytkownika i jest powiązana z access_token .
Po zaktualizowaniu uprawnień dla klienta wersja klienta jest zwiększana, a użytkownik jest powiadamiany, że aktualizacja jest dostępna. Użytkownicy muszą zaakceptować tę aktualizację klienta, zanim będą mogli używać zaktualizowanego produktu.
| Detale | |
|---|---|
| Zwroty | number Przykłady: 1, 17, 42 |
identyfikator użytkownika
Identyfikator użytkownika umożliwia identyfikację użytkowników we wszystkich wywołaniach interfejsu API. Ten identyfikator jest inny dla każdej kombinacji produktu Works with Nest i użytkownika.
Na przykład, jeśli użytkownik 1 autoryzował Works with Nest produkt A i Works with Nest B, to produkt A ma jedną wartość user_id dla użytkownika 1, a produkt B ma inną wartość user_id dla użytkownika 1.
| Detale | |
|---|---|
| Zwroty | string Przykład: z.1.1.7DHps ... |