Riferimento API Nest

L'API Nest modella una casa fisica o un edificio come struttura, con Nest Learning Thermostat, Nest Protect e Nest Cam come dispositivi nella struttura. Questa struttura contiene anche informazioni sulla casa nel suo complesso (come lo stato Fuori o Orario di arrivo stimato o le ore di punta attive).

Ogni elemento di dati nella struttura è indirizzabile da un URL della risorsa (chiamato "località dei dati") in un documento JSON condiviso. Ogni località dei dati può archiviare stringhe, numeri, booleani, oggetti padre/figlio o array.

Esplora il modello di dati con questo riferimento interattivo dell'API.

Dall'API, puoi sincronizzare i dati da posizioni a più livelli nel modello dati, ad esempio:

  • su un'intera struttura, inclusi tutti i dispositivi
  • un singolo dispositivo in una struttura
  • un gruppo di valori di dati (temperatura attuale e ambiente)
  • un singolo valore dati (stato di integrità della batteria)

I tuoi prodotti dovrebbero rispondere in modo ponderato a eventi come questi:

  • presenza (casa e fuori)
  • sicurezza (fumo e monossido di carbonio)
  • consumo di energia durante i momenti del giorno più costosi
  • events (suoni e movimenti)

Tuttavia, tieni presente che ognuno degli oggetti basati sul dispositivo funziona in base ai vincoli del mondo reale. Ad esempio, il termostato non deve far funzionare il condizionatore quando è attivo il riscaldamento di emergenza. La nostra API è concepita per salvaguardare i nostri dispositivi e la casa dell'utente e impedire determinate azioni in caso di sorpresa o pericolosa.

Autorizzazioni e dati del dispositivo condivisi

La possibilità di leggere o scrivere in una posizione dei dati è controllata dalle autorizzazioni. I gruppi di autorizzazioni forniscono l'accesso in lettura, scrittura o lettura/scrittura a determinati valori dei dati in dispositivi e strutture.

Per ulteriori informazioni, consulta la panoramica delle autorizzazioni.

Dati e privacy

I dati relativi ai prodotti per la casa possono essere molto personali. I dati dei sensori della casa contengono informazioni su come vivono le persone nel loro spazio personale. La sicurezza e la gestione di questi dati sono fondamentali per Nest e per un'attenzione significativa. Spieghiamo chiaramente agli utenti che tipo di dati abbiamo, come vengono utilizzati e dove possono controllarli.

Scopri di più sulle nostre viste sulla privacy.

Metadati

I metadati sono informazioni aggiuntive fornite quando effettui una chiamata all'endpoint di livello principale:

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

accesso_token

Dopo l'autorizzazione dell'utente, il prodotto utilizza un token di accesso per effettuare chiamate API al servizio Nest. Questo token di accesso serve a dimostrare che un utente ha autorizzato il tuo prodotto a effettuare chiamate per suo conto.

Dettagli
Restituiscestring
Esempio: "c.FmDPkzyzaQe..."

versione_client

La versione client è l'ultima versione autorizzata da un utente ed è associata a un elemento access_token.

Quando aggiorni le autorizzazioni per un client, la versione client viene incrementata e l'utente riceve una notifica che indica la disponibilità di un aggiornamento. Per poter utilizzare il prodotto aggiornato, i tuoi utenti devono accettare l'aggiornamento di questo client.

Dettagli
Restituiscenumber
Esempi: 1, 17, 42

user_id

Lo User-ID consente di identificare gli utenti durante le chiamate API. Questo identificatore varia a seconda della combinazione di prodotto e utente Works with Nest.

Ad esempio, se l'utente 1 ha autorizzato il prodotto Works with Nest A e il prodotto B con Nest, il prodotto A ha un valore user_id per l'utente 1 e il prodotto B ha un valore user_id diverso per l'utente 1.

Dettagli
Restituiscestring
Esempio: z.1.1.7DHps...