Documentation de référence sur l'API Nest

L'API Nest modélise une maison ou un bâtiment physique en tant que structure, avec les produits Nest Learning Thermostat, Nest Protect et Nest Cam en tant qu'appareils. Cette structure contient également des informations sur l'ensemble de la maison (par exemple, l'état Absent ou ATA, ou les heures de pointe actives).

Chaque élément de données de la structure est adressable par une URL de ressource (appelée "emplacements de données") dans un document JSON partagé. Chaque emplacement de données peut stocker des chaînes, des nombres, des valeurs booléennes, des objets parents/enfants ou des tableaux.

Explorez le modèle de données avec cette documentation de référence sur l'API interactive.

À partir de l'API, vous pouvez synchroniser les données de lieux à plusieurs niveaux du modèle de données, par exemple:

  • toute une structure comprenant tous les appareils ;
  • un seul appareil dans une structure
  • Un groupe de valeurs de données (température actuelle et ambiante)
  • Une seule valeur de données (état de la batterie)

Vos produits doivent réagir réfléchiment à ces événements:

Toutefois, n'oubliez pas que chaque objet basé sur l'appareil fonctionne dans des contraintes réelles. Par exemple, le thermostat ne doit pas exécuter la climatisation lorsque le chauffage d'urgence est activé. Notre API est conçue pour protéger à la fois nos appareils et la maison de nos utilisateurs, et empêchera certaines actions si elles étaient surprenantes ou dangereuses.

Autorisations et données partagées sur l'appareil

La possibilité de lire ou d'écrire dans un emplacement de données est contrôlée par les autorisations. Les groupes d'autorisations permettent d'accéder en lecture/écriture ou en lecture/écriture aux valeurs de données sélectionnées dans les appareils et les structures.

Pour en savoir plus, consultez la page Présentation des autorisations.

Données et confidentialité

Les données associées aux produits pour la maison peuvent être très personnelles. Les données des capteurs de la maison incluent des informations sur la façon dont les personnes vivent dans leur espace personnel. La sécurité et la gestion de ces données sont très importantes, et Nest concentre une importance particulière. Nous expliquons clairement aux utilisateurs le type de données dont nous disposons, leur utilisation et l'endroit où ils peuvent les contrôler.

En savoir plus sur nos vues concernant la confidentialité

Métadonnées

Les métadonnées sont des informations supplémentaires fournies lorsque vous appelez le point de terminaison racine:

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

access_token

Après l'autorisation de l'utilisateur, votre produit utilise un jeton d'accès pour effectuer des appels d'API vers le service Nest. Ce jeton d'accès sert à prouver qu'un utilisateur a autorisé votre produit à effectuer des appels en son nom.

Détails
Renvoiestring
Exemple: &c.FmDPkzyzaQe..."

version_client

La version client est la dernière version autorisée par l'utilisateur d'un client. Elle est associée à un access_token.

Lorsque vous mettez à jour les autorisations d'un client, la version du client est incrémentée et l'utilisateur est informé qu'une mise à jour est disponible. Pour utiliser votre produit mis à jour, vos utilisateurs doivent l'accepter.

Détails
Renvoienumber
Exemples: 1, 17, 42

user_id

L'ID utilisateur vous permet d'identifier les utilisateurs lors des appels d'API. Cet identifiant diffère de chaque combinaison de produit et d'utilisateur Works with Nest.

Par exemple, si l'utilisateur 1 a autorisé le produit Nest A et les produits Works with Nest, il y a une valeur user_id pour l'utilisateur 1 et le produit B avec une valeur user_id différente pour l'utilisateur 1.

Détails
Renvoiestring
Exemple: z.1.1.7DHps...