Notice: We're retiring Works with Nest. See the home page for more information.
O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.
Esta página foi traduzida pela API Cloud Translation.
Switch to English

Referência da API do Nest

A API do Nest modela uma casa ou edifício físico como uma estrutura, com termostatos de aprendizado do Nest, Nest Protects e Nest Cams como dispositivos na estrutura. Essa estrutura também contém informações sobre a casa como um todo (como Fora ou Estado ETA ou Horas de Ponta ativas).

Cada elemento de dados na estrutura é endereçável por uma URL de recurso (chamada "localizações de dados") em um documento JSON compartilhado. Cada local de dados pode armazenar cadeias, números, booleanos, objetos pai / filho ou matrizes.

Explore o modelo de dados com esta referência interativa da API .

Na API, você pode sincronizar dados de locais em vários níveis no modelo de dados, por exemplo:

  • uma estrutura inteira, incluindo todos os dispositivos
  • um único dispositivo em uma estrutura
  • um grupo de valores de dados (temperatura atual e ambiente)
  • um único valor de dados (estado de funcionamento da bateria)

Seus produtos devem responder cuidadosamente a eventos como estes:

No entanto, lembre-se de que cada um dos objetos baseados em dispositivo está funcionando sob restrições do mundo real. Por exemplo, o termostato não deve ligar o ar condicionado quando o calor de emergência estiver ativado. Nossa API foi projetada para proteger nossos dispositivos e a casa do usuário e evitará determinadas ações se elas forem surpreendentes ou perigosas.

Permissões e dados compartilhados do dispositivo

A capacidade de ler ou gravar em um local de dados é controlada por permissões. Grupos de permissão fornecem acesso de leitura, gravação ou leitura / gravação a valores de dados selecionados em dispositivos e estruturas.

Para mais informações, consulte a Visão geral das permissões .

Dados e privacidade

Os dados envolvidos nos produtos domésticos podem ser muito pessoais. Os dados do sensor doméstico contêm informações sobre como as pessoas vivem suas vidas em seu espaço pessoal. A segurança e o manuseio desses dados são muito importantes e um foco significativo na Nest. Tornamos claro para os usuários que tipo de dados temos, como são usados ​​e onde eles podem controlá-los.

Saiba mais sobre nossas opiniões sobre privacidade .

Metadados

Os metadados são informações adicionais fornecidas quando você faz uma chamada para o terminal no nível raiz:

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

access_token

Após a autorização do usuário, seu produto usa um token de acesso para fazer chamadas de API ao serviço Nest. Esse token de acesso serve como prova de que um usuário autorizou seu produto a fazer chamadas em nome deles.

Detalhes
Devoluções string
Exemplo: "c.FmDPkzyzaQe ..."

client_version

A versão do cliente é a última versão autorizada pelo usuário de um cliente e está associada a um access_token .

Quando você atualiza as permissões para um cliente, a versão do cliente é incrementada e o usuário é notificado de que uma atualização está disponível. Seus usuários devem aceitar esta atualização do cliente antes de poderem usar seu produto atualizado.

Detalhes
Devoluções number
Exemplos: 1, 17, 42

ID do usuário

O ID do usuário permite identificar usuários nas chamadas de API. Esse identificador é diferente para cada combinação de produto e usuário do Works with Nest.

Por exemplo, se o usuário 1 tiver autorizado o produto Works com Nest A e o produto B com Nest, o produto A possui um valor user_id para o usuário 1 e o produto B possui um valor user_id diferente para o usuário 1.

Detalhes
Devoluções string
Exemplo: z.1.1.7DHps ...