#API do Criador (Maker IPI)
Esta API é uma API HTTP GET simples que permite obter o status de seus dispositivos autorizados e interagir com eles.
¶ Instalando a API Maker
-
Na barra lateral do seu hub, selecione Aplicativos e pressione o botão Adicionar aplicativo integrado.
-
Escolha Maker API na lista de aplicativos integrados do Hubitat Elevation.
-
Você pode ativar o Log se quiser ver informações detalhadas em Logs. Lembre-se de abrir os logs em outra aba.
-
Selecione os dispositivos que deseja autorizar para esta instância da Maker API. Somente os dispositivos selecionados estarão acessíveis por meio dos endpoints desta instância da Maker API.
-
Selecione Atualizar
-
A seguir, você verá URLs para começar. Cada URL de terminal é composto dos seguintes segmentos:
http://[hub_ip_address]/apps/api/[app_id]/[endpoint_path]?access_token=[access_token]para terminais locais ou URLs de Internet semelhantes para terminais em nuvem. (Uma instância da Maker API pode ser configurada para permitir acesso somente LAN, acesso somente nuvem ou ambos.)
NOTA: Seu token de acesso é um token de autorização, semelhante a um nome de usuário e uma senha. Qualquer pessoa com esse token pode acessar esses endpoints. Para redefinir seu token de acesso, use a opção Criar novo token de acesso no aplicativo (ou crie uma nova instância da Maker API e remova-a).
- Selecione Concluído
¶ Para obter uma lista de todos os dispositivos autorizados
¶ /dispositivos
Isso retorna o seguinte JSON:
[
{
"id": "1",
"name": "Meu primeiro dispositivo",
"label": "Luz da sala de estar"
},
{
"id": "2",
"name": "Meu segundo dispositivo",
"label": "Interruptor da sala de estar"
}
]
¶ /dispositivos/todos
Isso retorna informações detalhadas sobre cada dispositivo autorizado em JSON:
[
{
"name": "Meu primeiro dispositivo",
"label": "Luz da Sala de Estar",
"type": "Comutador Virtual",
"id": "1",
"data": "2018-10-16T00:08:18+0000",
"modelo": nulo,
"fabricante": nulo,
"capacidades": [
"Trocar",
"Atualizar"
],
"atributos": {
"desligar"
},
"comandos": [
{
"comando": "desligado"
},
{
"comando": "ligado"
},
{
"comando": "atualizar"
}
]
},
{
"name": "Meu segundo dispositivo",
"label": "Interruptor da sala de estar",
"type": "Comutador Virtual",
"id": "2",
"data": "2018-01-03T02:49:57+0000",
"modelo": nulo,
"fabricante": nulo,
"capacidades": [
"Trocar",
"Atualizar"
],
"atributos": {
"ligar"
},
"comandos": [
{
"comando": "desligado"
},
{
"comando": "ligado"
},
{
"comando": "atualizar"
}
]
}
]
Este endpoint contém todas as informações conhecidas sobre o dispositivo, incluindo capacidades, atributos e comandos.
NOTA: Há um subconjunto limitado de comandos permitidos, portanto, só porque um comando aparece nesta lista não significa que funcionará por meio da API.
¶ /dispositivos/[id do dispositivo]
Este endpoint retorna os mesmos detalhes que /devices/all, mas apenas para um dispositivo específico.
¶ /devices/[id do dispositivo]/events
Retorna um objeto JSON de eventos recentes para o ID do dispositivo especificado.
[
{
"id_do_dispositivo": "1",
"label": "Luz da Sala de Estar",
"name": "Meu primeiro dispositivo",
"valor": "desligado",
"data": "2018-10-16T00:08:18+0000",
"isStateChange": nulo,
"fonte": "DISPOSITIVO"
}
]
¶ /devices/[id do dispositivo]/comandos
Retorna um objeto JSON dos comandos para esse [id do dispositivo]
[
{
"comando": "desligado"
},
{
"comando": "ligado"
},
{
"comando": "atualizar"
}
]
¶ /devices/[id do dispositivo]/[comando]/[valor secundário]
Este é o endpoint mais poderoso, pois pode enviar um comando para o ID do dispositivo autorizado, incluindo um parâmetro opcional ou vários parâmetros separados por vírgulas.
Exemplo: Para acender uma luz ID do dispositivo 1
/dispositivos/1/em
Exemplo 2: Para definir o nível de luz para 50%
/dispositivos/1/setLevel/50
Exemplo 3: Define um código de bloqueio para a posição 3 com o código 4321 e o nome "Convidado":
/dispositivos/1321/setCode/3,4321,Convidado
Você deveria receber um relatório completo