Jeedom ofrece a los desarrolladores y usuarios una API completo para que pueda controlar Jeedom desde cualquier objeto connecté.
Hay dos API disponibles : un piloto orientado al desarrollador JSON RPC 2.0 y otro a través de URL y solicitud HTTP.
Esta API se usa muy fácilmente mediante solicitudes HTTP simples a través de URL.
Nota
Para toda esta documentación, #IP_JEEDOM# coincide con tu url acceso a Jeedom. Esto es (a menos que esté conectado a su red local) de la dirección de Internet que utiliza para acceder a Jeedom desde afuera.
Nota
Para toda esta documentación, #API_KEY# coincide con tu llave API, específica para su instalación. Para encontrarlo, tienes que ir a el menú “General” → “Configuración” → pestaña “General””.
Aquí está la URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = escenario & id = #ID#&action=#ACTION#
identificación : coincide con su id de escenario. La identificación está en el página del escenario en cuestión, en "herramientas" → "Escenarios", una vez que escenario seleccionado, junto al nombre de la pestaña "General". otro manera de encontrarlo : en "Herramientas" → "Escenarios", haga clic en “Resumen”.
acción : corresponde a la acción que desea aplicar. la los pedidos disponibles son : “iniciar “,” detener “,” desactivar “y “activar “para iniciar, detener, desactivar o activar el escenario.
etiquetas \ [Opcional ] : si la acción es "inicio", puede omitir etiquetas para el escenario (ver documentación sobre escenarios) en las etiquetas de formulario = toto% 3D1% 20tata% 3D2 (tenga en cuenta que% 20 corresponde a un espacio y% 3D a = )
Aquí está la URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = cmd & id = #ID#
La forma más fácil de obtener esta URL es ir a la página Herramientas → Resumen de automatización del hogar, para buscar el comando y luego abrir su configuración avanzado (el icono de "engranaje") y allí verá una URL que contiene ya todo lo que necesita dependiendo del tipo y subtipo de commande.
Nota
Es posible para el campo #ID# para hacer múltiples pedidos de una vez. Para hacer esto, debe pasar una matriz en json (ex % 5B12,58,23% 5D, tenga en cuenta que \ [y ] deben estar codificados, de ahí que% 5B y% 5D). El regreso de Jeedom será un json
Nota
Los parámetros deben estar codificados para url, puede usar un utensilio, aquí
Aquí está la URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = interactuar y consultar = #QUERY#
pregunta : pregunta para hacerle a Jeedom
utf8 \ [Opcional ] : le dice a Jeedom si codifica la consulta en utf8 antes de intentar responder
vacío Respuesta \ [Opcional ] : 0 para que Jeedom responda incluso si no entendí, 1 de lo contrario
perfil \ [Opcional ] : nombre de usuario de la persona interacción desencadenante
responder_cmd \ [Opcional ] : ID de comando para usar para satisfacer la demanda
Aquí está la URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = mensaje y categoría = #CATEGORY#&message=#MESSAGE#
categoría : categoría de mensaje para agregar al centro de mensajes
Mensaje : mensaje en cuestión, tenga cuidado de pensar en la codificación el mensaje (el espacio se convierte en% 20, =% 3D). Puedes usar un outil, aquí
Aquí está la URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = object
Devuelve en json la lista de todos los objetos Jeedom
Aquí está la URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = eqLogic & object_id = #OBJECT_ID#
Aquí está la URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = comando & eqLogic_id = #EQLOGIC_ID#
Aquí está la URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = fullData
Devuelve todos los objetos, equipos, comandos (y su valor si esto son informaciones) en json
Aquí está la URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = variable & name = #NAME#&value=Valor
nombre : nombre de la variable cuyo valor se desea (lectura de el valor)
valor \ [Opcional ] : si se especifica "valor", entonces la variable tomará este valor (escribir un valor)