A API Nest funciona com todos os modelos de Nest CamTM.
Os usuários podem adicionar várias Nest Cams ao grupo devices/cameras
até o
máximo por
estrutura.
Ao fazer uma chamada para esse local de dados, você pode acessar os dados da Nest Cam (valores
de dados para dispositivos na estrutura).
Todos os valores abaixo são encontrados em cada
devices/cameras/device_id
no documento JSON.
ID do dispositivo
Identificador exclusivo da Nest Cam.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/device_id |
|
Retorna | string Exemplo: "awJo6rH..." |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
versão do software
Versão do software.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/software_version |
|
Retorna | string Exemplo: "4.0" |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
ID da estrutura
Identificador exclusivo da estrutura.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/structure_id |
|
Retorna | string Exemplo: "VqFabWH21nw..." |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
ID do local
Um identificador exclusivo gerado pelo Nest que representa
name
, o nome de exibição do dispositivo.
Saiba mais sobre os nomes dos Nest Thermostats, Nest Protects e Nest Cams.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/where_id |
|
Retorna | string Exemplo: "d6reb_OZTM..." |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
Nome_do_onde
O nome de exibição do dispositivo. Associados à Nest Cam
where_id
. Pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado. Saiba mais sobre os nomes dos Nest Thermostats, Nest Protects e Nest Cams.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/where_name |
|
Retorna | string Exemplo: "Hallway" |
Acesso | somente leitura |
Disponível em | Leitura/câmera da câmera / v3 Leitura da câmera + imagens / v4 Leitura/gravação da câmera / v3 Leitura/gravação da câmera + imagens / v4 |
nome
Nome de exibição do dispositivo. Pode ser qualquer nome de ambiente de uma lista fornecida ou um nome personalizado.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/name |
|
Retorna | string Exemplo: "Hallway" |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
nome_longo
Nome de exibição longo do dispositivo. Inclui um personalizado (rótulo), criado pelo usuário
ou pelo wheres
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/name_long |
|
Retorna | string Exemplo: "Hallway Nest Cam (escadas)" |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
on-line
Status da conexão do dispositivo com o serviço Nest.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/is_online |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
is_streaming
Status da câmera, com vídeo ativado ou desativado. Consulte Como sua câmera funciona com o Assistente dentro/fora de casa para mais informações.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/is_streaming |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | leitura/gravação |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
is_audio_input_enabled
Status do microfone da câmera, ligado e ligado ou desativado. Saiba mais sobre as configurações de áudio da Nest Cam.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/is_audio_input_enabled |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
last_is_online_change
Carimbo de data/hora que identifica a última alteração no status on-line, no formato ISO 8601.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_is_online_change |
|
Retorna | string Exemplo: "2016-12-29T18:42:00.000Z" |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
is_video_history_enabled
Status da assinatura do Nest Aware (assinatura ativa ou não).
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/is_video_history_enabled |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
URL da Web
URL da Web (link direto) para a transmissão de vídeo ao vivo em home.nest.com.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/web_url |
|
Retorna | string Exemplo: " https://home.nest.com/cameras/device_id?auth=camera_token " |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
URL do aplicativo
URL do app (link direto) para a transmissão de vídeo ao vivo no app Nest.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/app_url |
|
Retorna | string Exemplo: " nestmobile://cameras/device_id?auth=camera_token " |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
is_public_share_enabled
Os usuários podem compartilhar
o vídeo
e torná-lo visível para qualquer pessoa. Quando o compartilhamento público estiver ativado, você poderá ler
public_share_url
.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/is_public_share_enabled |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Leitura / gravação da câmera + imagens / v3-v4 Leitura/gravação da câmera + imagens / v3-v4 |
activity_zones
Retorna uma matriz de todas as Zonas de atividade definidas.
As zonas de atividades são usadas para monitorar eventos de movimento em áreas definidas pelo usuário do stream de vídeo. Exige o Nest Aware.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/activity_zones |
|
Retorna | array Exemplo: [ {"name" : "string1", "id" : "string2"},... ] • string1 é o nome da zona, definido pelo usuário ou gerado automaticamente quando ela é criada.• string2 é um identificador atribuído pela Nest quando a zona de atividade é criada. |
Acesso | somente leitura |
Disponível em | Leitura / gravação da câmera + imagens / v3-v4 Leitura/gravação da câmera + imagens / v3-v4 |
public_share_url
Você pode acessar esse URL quando um usuário torna o stream de vídeo público.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/public_share_url |
|
Retorna | string Exemplo: " https://video.nest.com/live/string1?string2 "string1 é o nome do stream de vídeo, seja definido pelo usuário ou gerado automaticamente quando o stream é definido como público. |
Acesso | somente leitura |
Disponível em | Leitura/gravação da câmera + imagens / v3-v4 Leitura/gravação da câmera + imagens / v3-v4 |
snapshot_url
Capture uma imagem sob demanda. Retorna o URL de uma imagem capturada do stream de vídeo ao vivo. Exige que a câmera esteja ativada e em streaming.
Use este campo para conseguir um snapshot do stream de vídeo ao vivo.
snapshot_url
: retorna o URL de uma imagem capturada do stream de vídeo ao vivo- Exige que a câmera esteja ligada e transmitindo ativamente
A qualidade do snapshot da API é de 1080p apenas se você:
- visualização ativa do fluxo da câmera no aplicativo
(
web_url
). - visualização do stream público
(
app_url
) - Assinante do Nest Aware
Se você não estiver visualizando ativamente o stream ou não tiver uma assinatura do Nest Aware, a API não terá uma fonte de 1080p para recuperar um snapshot nessa resolução e gerar uma imagem de qualidade inferior. Além disso, a baixa largura de banda da rede local pode fazer com que a resolução do snapshot da API fique abaixo de 1.080p com o Nest Aware.
Saiba mais sobre os requisitos de largura de banda para câmeras Nest.
Os limites de taxa se aplicam a esta chamada, dependendo do status de assinatura do Nest Aware.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/snapshot_url |
|
Retorna | string Exemplo: " string1/device_id/string2?auth=camera_token " |
Acesso | somente leitura |
Disponível em | Leitura/gravação da câmera + imagens / v3-v4 Leitura/gravação da câmera + imagens / v3-v4 |
último_evento
Esse objeto captura informações sobre o último evento que acionou uma notificação.
Alguns campos e algumas combinações de permissões exigem uma assinatura do Nest Aware para acessar as informações do último evento.
Todos os valores abaixo são encontrados em cada
devices/cameras/device_id/last_event
no documento
JSON.
has_sound
Evento de som: o som foi detectado.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/has_sound |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
has_motion
Evento de movimento: o movimento foi detectado.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/has_motion |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
has_person
Evento de pessoa: uma pessoa foi detectada.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/has_person |
|
Retorna | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
start_time
É o horário de início do evento, no formato ISO 8601.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/start_time |
|
Retorna | string Exemplo: "2016-12-29T00:00:00.000Z" |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
end_time
É o horário de término do evento, no formato ISO 8601.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/end_time |
|
Retorna | string Exemplo: "2016-12-29T00:00:00.000Z" |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
tempo_url_de_expiração
Carimbo de data/hora no formato ISO 8601, que identifica a expiração dos URLs relacionados a eventos:
O prazo de validade é calculado como:
last_event/start_time
+ n dias (em que n =
10 ou 30 dias, dependendo do plano de
assinatura do Nest Aware).
Exige o Nest Aware.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/urls_expire_time |
|
Retorna | string Exemplo: "2016-12-29T00:00:00.000Z" |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
URL da Web
URL da Web (link direto) para o último evento de som ou movimento em home.nest.com. Usado para exibir o último evento gravado e exige que o usuário faça login na conta.
Exige o Nest Aware. Se o URL do evento tiver expirado ou o dispositivo não tiver uma assinatura ativa, esse valor não será incluído no payload.
Consulte last_event/urls_expire_time
para
ver informações sobre o prazo de validade do URL.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/web_url |
|
Retorna | string Exemplo: " https://home.nest.com/cameras/device_id/cuepoints/string?auth=camera_token " |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
URL do aplicativo
URL do app Nest (link direto) para o último evento de som ou movimento. Usado para exibir o último evento gravado e exige que o usuário faça login na conta.
Exige o Nest Aware. Se o URL do evento tiver expirado ou o dispositivo não tiver uma assinatura ativa, esse valor não será incluído no payload.
Consulte last_event/urls_expire_time
para
ver informações sobre o prazo de validade do URL.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/app_url |
|
Retorna | string Exemplo: " nestmobile://cameras/device_id/cuepoints/string?auth=camera_token " |
Acesso | somente leitura |
Disponível em | Leitura/câmera / v1-v3 Leitura/câmera da câmera / v1-v4 Leitura/gravação da câmera / v1-v3 Leitura/gravação da câmera + imagens / v1-v4 |
image_url [URL_da_imagem]
URL (link) para o arquivo de imagem capturado para um evento de som ou movimento.
Exige o Nest Aware. Consulte
last_event/urls_expire_time
para
ver informações sobre o prazo de validade do URL.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/image_url |
|
Retorna | string Exemplo: " https://www.dropcam.com/api/wwn.get_image/string1/device_id/string2?auth=camera_token " |
Acesso | somente leitura |
Disponível em | Leitura / câmera da câmera + imagens / v1-v4 Leitura/gravação da câmera + imagens / v1-v4 |
URL_da_imagem_animada
URL (link) para o arquivo gif capturado para um evento de som ou movimento.
Exige o Nest Aware.
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/animated_image_url |
|
Retorna | string Exemplo: " https://www.dropcam.com/api/wwn.get_image/string1/device_id/string2?auth=camera_token " |
Acesso | somente leitura |
Disponível em | Leitura / câmera da câmera + imagens / v1-v4 Leitura/gravação da câmera + imagens / v1-v4 |
activity_zone_ids
Identificadores de zonas de atividade que detectaram um evento de movimento.
Exige o Nest Aware. Quando usado com a matriz activity_zones
, é possível ver o nome da zona desses IDs.
Se last_event/has_motion
for
true
= retorna os IDs da zona de atividade que detectaram um evento de movimentofalse
= retorna uma matriz vazia
Detalhes | |
---|---|
https://developer-api.nest.com/devices/cameras/device_id/last_event/activity_zone_ids |
|
Retorna | array Exemplo: [ string1, string2,... ] |
Acesso | somente leitura |
Disponível em | Leitura/gravação da câmera + imagens / v3-v4 Leitura/gravação da câmera + imagens / v3-v4 |