Notice: We're retiring Works with Nest. See the home page for more information.
Google is committed to advancing racial equity for Black communities. See how.
Эта страница переведена с помощью Cloud Translation API.
Switch to English

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

Nest API моделирует физический дом или здание как конструкцию, с термостатами Nest Learning, 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

ID пользователя

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

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

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