Notice: We're retiring Works with Nest. See the home page for more information.

Esta página foi traduzida pela API Cloud Translation.

API Structure

Os usuários podem adicionar no máximo três estruturas, com vários dispositivos por estrutura.

Todos os valores abaixo são encontrados em cada structures/structure_id no documento JSON.

ID da estrutura

Número do ID da estrutura. Ao fazer uma chamada para esse local de dados, você pode acessar os valores dos dados nessa estrutura.

Detalhes
`https://developer-api.nest.com/structures/structure_id/structure_id`
Retorna	`string` Exemplo: "VqFabWH21nw..."
Acesso	somente leitura
Disponível em	Leitura de termostato / v1-v6 Leitura/gravação de termostato na leitura / v1-v6 Leitura de fumaça/monóxido de carbono / v1-v5 Leitura longe / v1-v2 Leitura/gravação off-line / v1-v2 Leitura de HEC / v1-v2/leitura da câmera v1-2

Termostatos

Lista de termostatos na estrutura, por identificador exclusivo de dispositivo. Essa é uma matriz de objetos JSON que inclui todos os termostatos na estrutura.

Detalhes
`https://developer-api.nest.com/structures/structure_id/thermostats`
Retorna	`array` Exemplo: `[ "peyiJNo0IldT2YlIVtYaGQ",... ]`
Acesso	somente leitura
Disponível em	Leitura de termostato / v1-v6 Leitura/gravação de termostato + leitura v1-v6 Leitura de fumaça/monóxido de carbono / v1-v5 Leitura longe / v1-v2 Leitura/gravação ausente/

fumaça_co_alarmes

Lista de alarmes de fumaça + CO na estrutura por identificador exclusivo de dispositivo. Essa é uma matriz de objetos JSON que inclui todos os alarmes de fumaça + CO na estrutura.

Detalhes
`https://developer-api.nest.com/structures/structure_id/smoke_co_alarms`
Retorna	`array` Exemplo: `[ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ]`
Acesso	somente leitura
Disponível em	Leitura de termostato / v1-v6 Leitura/gravação de termostato + leitura v1-v6 Leitura de fumaça/monóxido de carbono / v1-v5 Leitura longe / v1-v2 Leitura/gravação ausente/

câmeras

Lista de câmeras na estrutura, por identificador exclusivo de dispositivo. Essa é uma matriz de objetos JSON que inclui todas as câmeras na estrutura.

Detalhes
`https://developer-api.nest.com/structures/structure_id/cameras`
Retorna	`array` Exemplo: `[ "awJo6rH...",... ]`
Acesso	somente leitura
Disponível em	Leitura de termostato / v4-v6 Leitura/gravação do termostato / v4-v6 Leitura de fumaça/monóxido de carbono / v4-v5 Leitura posterior / v2 Leitura/gravação ausente / v2 Leitura de HEC / v2 Leitura da câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1/gravação da câmera v1/v3

p/ chegar

Indica o estado de ocupação da estrutura.

As estruturas têm dois estados relacionados à presença: home ou away. Quando nenhum movimento é detectado na casa, a estrutura muda de home para away.

Detalhes
`https://developer-api.nest.com/structures/structure_id/away`
Retorna	`string` Valores: "home", "away"
Acesso	leitura/gravação
Disponível em	Leitura: Leitura de termostato / v1-v6 Leitura/gravação do termostato / v1-v6 Leitura de fumaça/CO / v1-v5 Leitura e saída / v1-v2 Leitura/gravação "ausentes" / Gravação de ETA / v1-v2/v1-2

nome

Nome de exibição da estrutura definido pelo usuário.

Detalhes
`https://developer-api.nest.com/structures/structure_id/name`
Retorna	`string` Exemplos: "My Home", "Beach House", "Mountain House"
Acesso	leitura/gravação
Disponível em	Ler / ler / usar o recurso Leitura em um dos idiomas / manual / manual / manual / ler / 2 / 2 / 1

country_code

Código do país, no formato ISO 3166 alpha-2.

Detalhes
`https://developer-api.nest.com/structures/structure_id/country_code`
Retorna	`string` Exemplos: "US", "CA", "UK"
Acesso	somente leitura
Disponível em	Leitura de termostato / v1-v6 Leitura/gravação do termostato / v1-v6 Leitura de fumaça + CO / v1-v5 Leitura ausente / v1-v2 Leitura/gravação ausente / v1-v2 Gravação de HEC / v1-v2

postal_code

CEP ou CEP, dependendo do país.

Detalhes
`https://developer-api.nest.com/structures/structure_id/postal_code`
Retorna	`string` Exemplos: "94304", "94304-1027", "EC1A 1BB"
Acesso	somente leitura
Disponível em	Leitura do código postal / v1-v2

pico_do_período_de_início_horário

Horário de início do evento do horário de pico de energia, no formato ISO 8601.

Detalhes
`https://developer-api.nest.com/structures/structure_id/peak_period_start_time`
Retorna	`string` Exemplo: "2016-12-31T23:59:59.000Z"
Acesso	somente leitura
Disponível em	Leitura de termostato / v1-v6 Leitura/gravação do termostato / v1-v6 Leitura de energia / v1-v2

pico_do_período_de_horário

É o horário de término do evento do horário de pico de energia, no formato ISO 8601.

Detalhes
`https://developer-api.nest.com/structures/structure_id/peak_period_end_time`
Retorna	`string` Exemplo: "2016-12-31T23:59:59.000Z"
Acesso	somente leitura
Disponível em	Leitura de termostato / v1-v6 Leitura/gravação do termostato / v1-v6 Leitura de energia / v1-v2

fuso horário

Fuso horário na estrutura, no formato fuso horário IANA.

Detalhes
`https://developer-api.nest.com/structures/structure_id/time_zone`
Retorna	`string` Exemplo: "América/Los_Angeles"
Acesso	somente leitura
Disponível em	Leitura de termostato / v1-v6 Leitura/gravação do termostato / v1-v6 Leitura de fumaça + CO / v1-v5 Leitura ausente / v1-v2 Leitura/gravação ausente / v2 Gravação de HEC / v1-v2

eta

O horário estimado de chegada é um objeto que pode ser definido em uma estrutura. Ele é usado para informar que um usuário provavelmente voltará para casa em um horário específico. Para informações sobre como fazer uma chamada de ETA, consulte o Guia de distância.

Detalhes

https://developer-api.nest.com/structures/structure_id/eta

Retorna object
Exemplo: "myTripID1024", "2014-10-31T22:42:00.000Z", "2016-12-31T23:59:59.000Z"

Parâmetros

`trip_id`	Uma string definida pelo usuário que identifica a viagem
`estimated_arrival_window_begin`	Timestamp no formato ISO 8601. Precisa ser maior que `NOW`.
`estimated_arrival_window_end`	Timestamp no formato ISO 8601. Precisa ser maior que `estimated_arrival_window_begin`.

Acesso somente gravação

Disponível em ETA gravado / v1-v2

eta_begin

Carimbo de data/hora da hora de chegada mais próxima no formato ISO 8601. Usado para acionar ações ou eventos.

Detalhes
`https://developer-api.nest.com/structures/structure_id/eta_begin`
Retorna	`string` Exemplo: "2016-12-31T23:59:59.000Z"
Acesso	somente leitura
Disponível em	ETA lido / v1

Inscrição rhr

Status do registro de Recompensas em horário de pico.

Detalhes
`https://developer-api.nest.com/structures/structure_id/rhr_enrollment`
Retorna	`boolean` Valores: verdadeiro, falso
Acesso	somente leitura
Disponível em	Leitura de energia / v1-v2

wwn_security_state [estado_da_segurança_de_wwn]

Estrutura do estado de segurança.

Detalhes
`https://developer-api.nest.com/structures/structure_id/wwn_security_state`
Tipo	`string enum` Valores: "ok", "deter"
Acesso	somente leitura
Disponível em	Leitura de estado de segurança / v1

Onde

Objeto que contém os identificadores de localização (where_id e name) para dispositivos na estrutura. name é o nome de exibição do dispositivo. Pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado.

Para mais informações sobre wheres, consulte o Guia de estrutura.

Saiba mais sobre os nomes dos Nest Thermostats, Nest Protects e Nest Cams.

Detalhes
`https://developer-api.nest.com/structures/structure_id/wheres`
Retorna	`object`
Acesso	somente leitura
Disponível em	Leitura: Leitura de termostato/v3-v6 Leitura/gravação de termostato/v3-v6 Leitura de fumaça/CO / v3-v5 Leitura de câmera / v1-v3 Leitura/gravação da câmera / imagens / v1-v4

ID do local

Um identificador exclusivo gerado pelo Nest que representa a name.

where_id é criado e retornado automaticamente durante a chamada para criar name.

Detalhes
`https://developer-api.nest.com/structures/structure_id/wheres/where_id/where_id`
Retorna	`string` Exemplo: "Fqp6wJI..."
Acesso	somente leitura
Disponível em	Leitura: Leitura de termostato / v3-v6 Leitura/gravação de termostato / v3-v6 Leitura de fumaça e CO2 / v3-v5 Leitura de câmera / v1-v3 Leitura de câmera + imagens / v1-v4 Leitura/gravação de câmera / v1-v3 Leitura/gravação da câmera + imagens / v1

nome

O nome de exibição do dispositivo.

Detalhes
`https://developer-api.nest.com/structures/structure_id/wheres/where_id/name`
Retorna	`string` Exemplo: "Broomroom"
Acesso	leitura/gravação Atenção: esse valor de dados não pode ser editado nem excluído após a criação.
Disponível em	Leitura: Leitura de termostato/v3-v6 Leitura/gravação de termostato/v3-v6 Leitura de fumaça/CO / v3-v5 Leitura de câmera / v1-v3 Leitura/gravação da câmera / imagens / v1-v4

co_alarme_estado

Status do alarme de monóxido de carbono.

Detalhes
`https://developer-api.nest.com/structures/structure_id/co_alarm_state`
Retorna	`string enum` Valores: "ok", "warning", "emergência"
Acesso	somente leitura
Disponível em	Leitura de fumaça/monóxido de carbono/v5

fumaça_alarme_estado

Status do alarme do detector de fumaça

Detalhes
`https://developer-api.nest.com/structures/structure_id/smoke_alarm_state`
Retorna	`string enum` Valores: "ok", "warning", "emergência"
Acesso	somente leitura
Disponível em	Leitura de fumaça/monóxido de carbono/v5