Les utilisateurs peuvent ajouter trois structures maximum, avec plusieurs appareils par structure.
Toutes les valeurs ci-dessous sont situées sous chaque structures/structure_id
dans le document JSON.
structure_id [id_structure]
Identifiant de la structure. Lorsque vous appelez cet emplacement de données, vous pouvez accéder aux valeurs de données dans cette structure.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/structure_id |
|
Renvoie | string Exemple : VqFabWH21nw..." |
Accès | lecture seule |
Disponible en | Thermostat en lecture/v1-v6 Lecture/Écriture sur le thermostat/v1-v6 Lecture/écriture du détecteur de fumée/v1-v5 Lecture en écriture seule/v1-v2 Lecture/écriture en mode Absent/v2-v2 Lecture en écriture pour l'appareil photo/v1-v2 Lecture avec l'appareil photo/v2-v3 pour l'appareil photo/v1-v3 |
thermostats
Liste des thermostats de la structure, par identifiant d'appareil unique. Il s'agit d'un tableau d'objets JSON comprenant tous les thermostats de la structure.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/thermostats |
|
Renvoie | array Exemple: [ "peyiJNo0IldT2YlIVtYaGQ",... ] |
Accès | lecture seule |
Disponible en | Thermostat en lecture/v1-v6 Lecture/Écriture sur le thermostat / v1-v6 Lecture/écriture du détecteur de fumée/v1-v5 Lecture/Absent / v1-v2 Lecture/écriture de l'appareil / v1-v2 Lecture de l'appareil photo / v1-v2 Lecture de l'appareil photo / v2-v3 Lecture de l'appareil photo + v2-v4/v2-v4 Lecture de l'appareil photo + v2-v4/v2-v4 |
détecteurs de fumée
Liste des détecteurs de fumée et de monoxyde de carbone dans la structure, par identifiant unique d'appareil. Il s'agit d'un tableau d'objets JSON comprenant tous les détecteurs de fumée et de monoxyde de carbone dans la structure.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/smoke_co_alarms |
|
Renvoie | array Exemple : [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ] |
Accès | lecture seule |
Disponible en | Thermostat en lecture/v1-v6 Lecture/Écriture sur le thermostat / v1-v6 Lecture/écriture du détecteur de fumée/v1-v5 Lecture/Absent / v1-v2 Lecture/écriture de l'appareil / v1-v2 Lecture de l'appareil photo / v1-v2 Lecture de l'appareil photo / v2-v3 Lecture de l'appareil photo + v2-v4/v2-v4 Lecture de l'appareil photo + v2-v4/v2-v4 |
appareils photo
Liste des caméras de la structure, par identifiant d'appareil unique. Tableau d'objets JSON comprenant toutes les caméras de la structure.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/cameras |
|
Renvoie | array Exemple: [ "awJo6rH...",... ] |
Accès | lecture seule |
Disponible en | Thermostat en lecture/v4-v6 Lecture/écriture sur le thermostat/v4-v6 Lecture/écriture du fumée/CO dans v4-v5 Lecture depuis l'appareil/v2 Absent en lecture/écriture/v2 ETA en écriture/v2 Lecture en écriture/v1-v3 sur l'appareil photo v/v-v4 |
absent
Indique l'état d'occupation de la structure.
Les structures présentent deux états liés à la présence : home
ou away
. Lorsqu'aucun mouvement n'est détecté dans la maison, la structure passe de home
à away
.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/away |
|
Renvoie | string Valeurs : domicile et domicile |
Accès | lecture/écriture |
Disponible en | Lecture : Read read/v1-v6 Thermostat read/write / v1-v6 Smoke+CO read / v1-v5 Away read / v1-v2 Away read/write / v1-v2 ATA write / v1-v2 Write: /read v1-v2 Write / v1-v2 |
name
Nom à afficher de la structure, défini par les utilisateurs
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/name |
|
Renvoie | string Exemples : "Ma maison", "Maison de plage" et "Maison de montagne" |
Accès | lecture/écriture |
Disponible en | Excellente qualité d'image lors de la résolution de vos problèmes de qualité |
country_code
Code pays au format ISO 3166 alpha-2.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/country_code |
|
Renvoie | string Exemples : "États-Unis", "Canada" et "Royaume-Uni" |
Accès | lecture seule |
Disponible en | Thermostat en lecture / v1-v6 Lecture/Écriture du thermostat / v1-v6 Lecture en écriture (CO+)/V1-v5 Absent en lecture / v1-v2 Lecture/écriture en Absent / v1-v2 ETA en écriture / v1-v2 |
postal_code [code_postal]
Code postal, selon le pays.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/postal_code |
|
Renvoie | string Exemples : 94304 "94304-1027&ECTA 1BB |
Accès | lecture seule |
Disponible en | Lecture de code postal / v1-v2 |
sommet_période_début
Heure de début de l'événement Heure de pointe énergétique, au format ISO 8601.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/peak_period_start_time |
|
Renvoie | string Exemple : "2016-12-31T23:59:59.000Z"" |
Accès | lecture seule |
Disponible en | Thermostat en lecture/v1-v6 Lecture/écriture du thermostat/v1-v6 Lecture en énergie/v1-v2 |
sommet_période_fin
Heure de fin de l'événement hour rush (heure de pointe énergétique), au format ISO 8601.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/peak_period_end_time |
|
Renvoie | string Exemple : "2016-12-31T23:59:59.000Z"" |
Accès | lecture seule |
Disponible en | Thermostat en lecture/v1-v6 Lecture/écriture du thermostat/v1-v6 Lecture en énergie/v1-v2 |
fuseau horaire
Fuseau horaire de la structure, au format fuseau horaire IANA.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/time_zone |
|
Renvoie | string Exemple: "Amérique/Los_Angeles" |
Accès | lecture seule |
Disponible en | Thermostat en lecture/v1-v6 Lecture/Écriture sur le thermostat/v1-v6 Lecture en écriture (CO+)/V1-v5 Absent en lecture/v1-v2 Lecture/écriture en Absent/v2 ETA en écriture/v1-v2 |
heure d'arrivée prévue
L'heure d'arrivée prévue est un objet qui peut être défini sur une structure. Elle permet d'informer Nest qu'un utilisateur doit rentrer à la maison à une heure spécifique. Pour savoir comment passer un appel ETA, consultez le guide de l'absence.
Détails | |||||||
---|---|---|---|---|---|---|---|
https://developer-api.nest.com/structures/structure_id/eta |
|||||||
Renvoie | object Exemple: &myTripID1024"2014-10-31T22:42:00.000Z"2016-12-31T23:59:59.000Z" |
||||||
Paramètres |
|
||||||
Accès | écriture seule | ||||||
Disponible en | ATA / Write v1-v2 |
début_eta
Horodatage de l'heure d'arrivée prévue au format ISO 8601. Permet de déclencher des actions ou des événements.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/eta_begin |
|
Renvoie | string Exemple : "2016-12-31T23:59:59.000Z"" |
Accès | lecture seule |
Disponible en | ATA en lecture / version 1 |
rhr_enrollment
État de votre inscription à Primes en heures de pointe.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/rhr_enrollment |
|
Renvoie | boolean Valeurs: true, false |
Accès | lecture seule |
Disponible en | Énergie lue / v1-v2 |
wwn_security_state
État de sécurité de la structure.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/wwn_security_state |
|
Type | string enum Valeurs : "ok", dissuasion |
Accès | lecture seule |
Disponible en | Lecture de l'état de sécurité / v1 |
Où
Objet contenant les identifiants (where_id
et name
) pour les appareils de la structure. name
est le nom à afficher de l'appareil. Il peut s'agir de n'importe quel nom de pièce d'une liste que nous fournissons ou d'un nom personnalisé.
Pour en savoir plus sur wheres
, consultez le Guide de structure.
En savoir plus sur l'emplacement des différentes versions des thermostats Nest, des Nest Protect et des Nest Cam
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres |
|
Renvoie | object |
Accès | lecture seule |
Disponible en | Lecture: Lecture/Thermostat v3-v6 Lecture/Écriture sur le thermostat/v3-v6 Lecture/Écriture de fumée+/v3-v5 Lecture/écriture de l'appareil photo/v1-v3 Lecture/Lecture des images de la caméra/v1-v4 Lecture/Écriture de l'appareil photo/v1-v3 Caméra / lecture/écriture + v1-v1 |
Où_id
Identifiant unique généré par Nest, qui représente name
.
where_id
est automatiquement créé et affiché lors de l'appel pour créer name
.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id |
|
Renvoie | string Exemple: &qt6wJI..." |
Accès | lecture seule |
Disponible en | Lecture: Lecture seule/Thermostat v3-v6 Lecture/écriture du thermostat/v3-v6 Lecture/Écriture de fumée+CO/v3-v5 Lecture/écriture de l'appareil photo/v1-v3 Lecture/Écriture de l'appareil photo/v1-v4 Lecture/écriture de l'appareil photo/v1-v3 Lecture/écriture de l'appareil photo+ v1-v4 |
name
Nom à afficher de l'appareil.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/wheres/where_id/name |
|
Renvoie | string Exemple : "chambre" |
Accès | read/write |
Disponible en | Lecture: Thermostat avec lecture/v3-v6 Thermostat en lecture/écriture/v3-v6 Fumée+CO lecture/v3-v5 Caméra avec lecture/écriture / v1-v3 Caméra avec lecture/images / v1-v4 Caméra avec lecture/écriture/v1-v3 Caméra avec lecture/écriture + v1-v3 |
co_alarm_state (État de l'alarme)
État de l'alarme du détecteur de monoxyde de carbone.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/co_alarm_state |
|
Renvoie | string enum Valeurs : ok, urgence, avertissement et urgence |
Accès | lecture seule |
Disponible en | Smoke+CO read / v5 |
fumée_état
État du détecteur de fumée.
Détails | |
---|---|
https://developer-api.nest.com/structures/structure_id/smoke_alarm_state |
|
Renvoie | string enum Valeurs : ok, urgence, avertissement et urgence |
Accès | lecture seule |
Disponible en | Smoke+CO read / v5 |