Nest API 会为实体住宅或建筑物建模,而结构中采用 Nest Learning Learning Thermostat、Nest Protect 和 Nest Cam。该结构还包含有关整个住宅的信息(例如外出或 ETA 状态,或活跃的高峰期)。
结构中的每个数据元素都可以通过共享 JSON 文档中的资源网址(称为“数据位置”)进行寻址。每个数据位置都可以存储字符串、数字、布尔值、父/子对象或数组。
通过此互动式 API 参考文档探索数据模型。
在 API 中,您可以从数据模型中多个层级的位置同步数据,例如:
- 整个结构,包括所有设备
- 结构中的单个设备
- 一组数据值(当前温度和环境温度)
- 单个数据值(电池状况)
您的商品应慎重对如下事件的响应:
但请注意,每个基于设备的对象都在现实世界的限制下运行。例如,启用应急热源后,温控器不应运行空调。我们的 API 旨在同时保护设备和用户住宅,并会防范令人感到惊讶或危险的某些操作。
权限和共用设备数据
拥有读取或写入数据位置的权限由权限控制。权限组提供对设备和结构中所选数据值的读取、写入或读取/写入权限。
如需了解详情,请参阅权限概览。
数据和隐私
家居用品所涉及的数据可能非常个性化。家居传感器数据包含人们如何在个人空间中生活。这些数据的安全和处理非常重要,并且是 Nest 的重点。我们向用户明确说明我们拥有哪些类型的数据,如何使用这些数据,以及他们可以在何处控制这些数据。
详细了解我们在隐私保护方面的观点。
元数据
元数据是您调用根级端点时提供的其他信息:
https://developer-api.nest.com/
access_token
用户授权后,您的产品会使用访问令牌对 Nest 服务进行 API 调用。此访问令牌可证明用户已授权您的产品代表他们进行调用。
详情 | |
---|---|
返回结果 | string 示例:&cot;c.FmDPkzyzaQe..." |
client_version [客户端版本]
客户端版本是用户授权的最后一个客户端版本,与 access_token
相关联。
更新客户端的权限时,客户端版本会递增,且系统会通知用户有可用更新。您的用户必须先接受此客户端更新,然后才能使用更新后的产品。
详情 | |
---|---|
返回结果 | number 示例:1、17、42 |
user_id
借助 User-ID,您可以在所有 API 调用中标识用户。此标识符因 Works with Nest 产品和用户组合的不同而异。
例如,如果用户 1 已授权 Works with Nest 产品 A,而使用 Nest 产品 B,则产品 A 为用户 1 分配一个 user_id
值,产品 B 为用户 1 分配一个不同的 user_id
值。
详情 | |
---|---|
返回结果 | string 示例:z.1.1.7DHps... |