La API de Nest modela una casa física o un edificio como una estructura, con los Nest Learning Thermostats, Nest Protects y las Nest Cams como dispositivos de la estructura. Esta estructura también contiene información sobre la casa en su totalidad (como el estado de Ausente o ETA, o bien las horas pico de energía activas).
Se puede acceder a cada elemento de datos en la estructura mediante una URL de recurso (llamada ubicaciones de datos) en un documento JSON compartido. Cada ubicación de datos puede almacenar strings, números, valores booleanos, objetos superiores o secundarios, o arreglos.
Explora el modelo de datos con esta referencia interactiva de la API.
Desde la API, puedes sincronizar datos de ubicaciones en varios niveles del modelo de datos, por ejemplo:
- una estructura completa, incluidos todos los dispositivos
- un solo dispositivo en una estructura
- un grupo de valores de datos (temperatura ambiente y actual)
- un solo valor de datos (estado de la batería)
Sus productos deben responder con cuidado a eventos como los siguientes:
- presence (en casa y fuera)
- seguridad (humo y monóxido de carbono)
- energía durante los momentos costosos del día
- eventos (sonido y movimiento)
Sin embargo, ten en cuenta que cada uno de los objetos basados en dispositivos funciona bajo restricciones del mundo real. Por ejemplo, el termostato no debería hacer funcionar el aire acondicionado cuando esté habilitado el calefactor de emergencia. Nuestra API está diseñada para proteger nuestros dispositivos y la casa del usuario, y evitará ciertas acciones si son sorprendentes o peligrosas.
Permisos y datos del dispositivo compartido
La capacidad de leer una ubicación de datos o escribir en ella se controla mediante permisos. Los grupos de permisos proporcionan acceso de lectura, escritura o lectura/escritura a los valores de datos seleccionados en dispositivos y estructuras.
Para obtener más información, consulta la Descripción general de permisos.
Datos y privacidad
Los datos relacionados con los productos para el hogar pueden ser muy personales. Los datos de los sensores de la casa contienen información sobre cómo las personas viven sus vidas en su espacio personal. La seguridad y el manejo de esos datos son muy importantes y se deben enfocar en Nest. Dejamos claro a los usuarios qué tipo de datos tenemos, cómo se usan y dónde pueden controlarlos.
Obtén más información sobre nuestras vistas de privacidad.
Metadatos
Los metadatos son información adicional que se proporciona cuando haces una llamada al extremo de nivel raíz:
https://developer-api.nest.com/
access_token
Después de la autorización del usuario, tu producto usa un token de acceso para realizar llamadas a la API al servicio de Nest. Este token de acceso sirve como prueba de que el usuario autorizó tu producto para realizar llamadas en su nombre.
| Detalles | |
|---|---|
| Qué muestra | stringEjemplo: "c.FmDPkzyzaQe..." |
versión_cliente
La versión del cliente es la última versión autorizada de un cliente y se asocia con un access_token.
Cuando actualizas los permisos para un cliente, la versión del cliente aumenta, y el usuario recibe una notificación de que hay una actualización disponible. Tus usuarios deben aceptar esta actualización del cliente para poder usar tu producto actualizado.
| Detalles | |
|---|---|
| Qué muestra | numberEjemplos: 1, 17, 42 |
user_id
El ID de usuario te permite identificar usuarios en llamadas a la API. Este identificador difiere para cada combinación de producto y usuario de Works with Nest.
Por ejemplo, si el usuario 1 autorizó el producto A y Works with Nest, y el producto B tiene el valor user_id para el usuario 1, y el producto B tiene un valor user_id diferente para el usuario 1.
| Detalles | |
|---|---|
| Qué muestra | stringEjemplo: z.1.1.7DHps... |