Справочник по API Nest

Nest API моделирует физический дом или здание как структуру с обучаемыми термостатами Nest, Nest Protects и Nest Cams в качестве устройств в структуре. Эта структура также содержит информацию о доме в целом (например, состояние «Нет на месте» или «Прибытие» или активные часы пик).

Каждый элемент данных в структуре доступен по URL-адресу ресурса (называемого «расположением данных») в общем документе JSON. В каждом расположении данных могут храниться строки, числа, логические значения, родительские/дочерние объекты или массивы.

Изучите модель данных с помощью этого интерактивного справочника по API .

С помощью API вы можете синхронизировать данные из местоположений на нескольких уровнях модели данных, например:

  • вся структура, включая все устройства
  • одно устройство в структуре
  • группа значений данных (текущая и температура окружающей среды)
  • одно значение данных (состояние батареи)

Ваши продукты должны продуманно реагировать на подобные события:

Однако имейте в виду, что каждый из объектов на основе устройств работает с реальными ограничениями. Например, термостат не должен запускать кондиционер, когда включен аварийный нагрев. Наш API предназначен для защиты как наших устройств, так и дома пользователя, и предотвращает определенные действия, если они могут быть неожиданными или опасными.

Разрешения и общие данные устройства

Возможность чтения или записи в расположение данных контролируется разрешениями. Группы разрешений обеспечивают доступ для чтения, записи или чтения/записи к выбранным значениям данных в устройствах и структурах.

Дополнительные сведения см. в разделе Обзор разрешений .

Данные и конфиденциальность

Данные, связанные с товарами для дома, могут быть очень личными. Данные датчика дома содержат информацию о том, как люди проживают свою жизнь в своем личном пространстве. Безопасность и обработка этих данных очень важны и находятся в центре внимания Nest. Мы четко даем пользователям понять, какие данные у нас есть, как они используются и где они могут их контролировать.

Узнайте больше о наших взглядах на конфиденциальность .

Метаданные

Метаданные — это дополнительная информация, которая предоставляется при вызове конечной точки корневого уровня:

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

access_token

После авторизации пользователя ваш продукт использует токен доступа для вызовов API к сервису Nest. Этот токен доступа служит доказательством того, что пользователь разрешил вашему продукту совершать звонки от его имени.

Подробности
Возвращает string
Пример: "c.FmDPkzyzaQe..."

client_version

Версия клиента — это последняя авторизованная пользователем версия клиента, связанная с access_token .

Когда вы обновляете разрешения для клиента, увеличивается версия клиента, и пользователь уведомляется о наличии обновления. Ваши пользователи должны принять это обновление клиента, прежде чем они смогут использовать ваш обновленный продукт.

Подробности
Возвращает number
Примеры: 1, 17, 42

Логин пользователя

Идентификатор пользователя позволяет идентифицировать пользователей при вызовах API. Этот идентификатор отличается для каждой комбинации продукта Works with Nest и пользователя.

Например, если пользователь 1 авторизовал Works with Nest product A и Works with Nest product B, то продукт A имеет одно значение user_id для пользователя 1, а продукт B имеет другое значение user_id для пользователя 1.

Подробности
Возвращает string
Пример: z.1.1.7DHps...