A API Nest modela uma casa ou um prédio físico como uma estrutura, com os Nest Learning Thermostats, Nest Protects e Nest Cams como dispositivos na estrutura. Essa estrutura também contém informações sobre a casa como um todo (como Ausente, estado de HEC ou Horário de pico ativo).
Cada elemento de dados na estrutura é endereçável por um URL de recurso (chamado de "locais de dados") em um documento JSON compartilhado. Cada local de dados pode armazenar strings, números, booleanos, objetos pai/filho ou matrizes.
Explore o modelo de dados com esta Referência de API interativa.
Na API, é possível 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 ambiente e atual)
- um único valor de dados (estado de integridade da bateria)
Seus produtos precisam responder bem a eventos como estes:
- presence (casa e ausente)
- segurança (fumaça e monóxido de carbono)
- uso de energia durante períodos caros do dia;
- eventos (som e movimento)
No entanto, lembre-se de que cada objeto baseado em dispositivo está trabalhando com restrições reais. Por exemplo, o termostato não executará o ar-condicionado quando o aquecimento de emergência estiver ativado. Nossa API foi desenvolvida para proteger nossos dispositivos e a casa do usuário e impedirá determinadas ações caso eles sejam surpreendentes ou perigosos.
Permissões e dados compartilhados do dispositivo
A capacidade de ler ou gravar em um local de dados é controlada por permissões. Os grupos de permissões fornecem acesso de leitura, gravação ou leitura/gravação aos valores de dados selecionados em dispositivos e estruturas.
Para mais informações, consulte a Visão geral de permissões.
Dados e privacidade
Os dados envolvidos nos produtos domésticos podem ser muito pessoais. Os dados do sensor residencial contêm informações sobre como as pessoas vivem a vida no espaço pessoal. A segurança e o tratamento desses dados são muito importantes e têm um foco significativo na Nest. Deixamos claro para os usuários o tipo de dados que temos, como eles são usados e onde eles podem controlá-los.
Saiba mais sobre nossas visualizações sobre privacidade.
Metadados
Os metadados são informações adicionais fornecidas quando você faz uma chamada para o endpoint no nível raiz:
https://developer-api.nest.com/
access_token
Após a autorização do usuário, o produto usa um token de acesso para fazer chamadas de API para o serviço Nest. Esse token de acesso serve como prova de que um usuário autorizou seu produto a fazer chamadas em nome dele.
| Detalhes | |
|---|---|
| Retorna | stringExemplo: "c.FmDPkzyzaQe..." |
versão_do_cliente
A versão do cliente é a última versão autorizada pelo usuário e associada
a uma access_token.
Quando você atualiza as permissões de um cliente, a versão do cliente é incrementada, e o usuário é notificado de que uma atualização está disponível. Os usuários precisam aceitar a atualização do cliente antes de usar o produto atualizado.
| Detalhes | |
|---|---|
| Retorna | numberExemplos: 1, 17, 42 |
user_id
O User ID permite identificar usuários em chamadas de API. Esse identificador é diferente para cada combinação de produtos e usuários do Works with Nest.
Por exemplo, se o usuário 1 tiver autorizado o produto Works with Nest A e
o produto B funcionar, o produto A terá um valor user_id para o usuário 1
e o produto B terá um valor user_id diferente para o usuário 1.
| Detalhes | |
|---|---|
| Retorna | stringExemplo: z.1.1.7DHps... |