L'API Nest modélise une maison ou un bâtiment physique en tant que structure, avec les Nest Learning Thermostats, les Nest Protect et les Nest Cam comme appareils dans la structure. Cette structure contient également des informations sur la maison dans son ensemble (comme l'état Absent ou ETA, 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 booléens, des objets parents / enfants ou des tableaux.
Explorez le modèle de données avec cette référence API interactive .
À partir de l'API, vous pouvez synchroniser des données à partir d'emplacements à plusieurs niveaux dans le modèle de données, par exemple:
- une structure entière, y compris 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 santé de la batterie)
Vos produits doivent réagir de manière réfléchie à des événements comme ceux-ci:
- présence (à la maison et à l'extérieur)
- sécurité (fumée et monoxyde de carbone)
- consommation d'énergie pendant les périodes de journée chères
- événements (son et mouvement)
Cependant, gardez à l'esprit que chacun des objets basés sur le périphérique fonctionne sous des contraintes du monde réel. Par exemple, le thermostat ne doit pas faire fonctionner le climatiseur lorsque le chauffage d'urgence est activé. Notre API est conçue pour protéger à la fois nos appareils et le domicile de l'utilisateur, et empêchera certaines actions si elles étaient surprenantes ou dangereuses.
Autorisations et données d'appareil partagées
La capacité de lire ou d'écrire dans un emplacement de données est contrôlée par des autorisations. Les groupes d'autorisations fournissent un accès en lecture, en écriture ou en lecture / écriture aux valeurs de données sélectionnées dans les périphériques et les structures.
Pour plus d'informations, consultez la vue d'ensemble des autorisations .
Données et confidentialité
Les données liées aux produits pour la maison peuvent être très personnelles. Les données des capteurs domestiques contiennent des informations sur la façon dont les gens vivent leur vie dans leur espace personnel. La sécurité et le traitement de ces données sont très importants et constituent une priorité chez Nest. Nous expliquons clairement aux utilisateurs le type de données dont nous disposons, comment elles sont utilisées et où ils peuvent les contrôler.
En savoir plus sur nos opinions sur la confidentialité .
Métadonnées
Les métadonnées sont des informations supplémentaires fournies lorsque vous appelez le point de terminaison de niveau racine:
https://developer-api.nest.com/
jeton d'accès
Après l'autorisation de l'utilisateur, votre produit utilise un jeton d'accès pour passer des appels API au service Nest. Ce jeton d'accès sert de preuve qu'un utilisateur a autorisé votre produit à passer des appels en son nom.
| Détails | |
|---|---|
| Retour | string Exemple: "c.FmDPkzyzaQe ..." |
client_version
La version du client est la dernière version autorisée par l'utilisateur d'un client et 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 averti qu'une mise à jour est disponible. Vos utilisateurs doivent accepter cette mise à jour client avant de pouvoir utiliser votre produit mis à jour.
| Détails | |
|---|---|
| Retour | number Exemples: 1, 17, 42 |
identifiant d'utilisateur
L'ID utilisateur vous permet d'identifier les utilisateurs à travers les appels d'API. Cet identifiant diffère pour chaque produit Works with Nest et combinaison d’utilisateur.
Par exemple, si l'utilisateur 1 a autorisé le produit Works with Nest A et Works with Nest B, le produit A a une valeur user_id pour l'utilisateur 1 et le produit B a une valeur user_id différente pour l'utilisateur 1.
| Détails | |
|---|---|
| Retour | string Exemple: z.1.1.7DHps ... |