Jeedom provides developers and users with an API complete so you can control Jeedom from any object connecté.

Two APIs are available : a developer oriented pilot JSON RPC 2.0 and another via URL and HTTP request.

This API is very easily used by simple HTTP requests via URL.

NOTE

For all of this documentation, #IP_JEEDOM# matches your url access to Jeedom. This is (unless you are connected to your network local) of the internet address you use to access Jeedom from the outside.

NOTE

For all of this documentation, #API_KEY# matches your key API, specific to your installation. To find it, you have to go to the “General” menu → “Configuration” → “General” tab”.

Scenario

Here is the URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = scenario & id = #ID#&action=#ACTION#

Info / Action command

Here is the URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = cmd & id = #ID#

The easiest way to get this URL is to go to the Tools page → Home automation summary, to search for the command then to open its configuration advanced (the "gear" icon) and there you will see a URL that contains already all you need depending on the type and subtype of the commande.

NOTE

It is possible for the field #ID# to place multiple orders at once. To do this, you must pass an array in json (ex % 5B12,58,23% 5D, note that \ [and ] must be encoded, hence the% 5B and% 5D). Jeedom's return will be a json

NOTE

Parameters must be encoded for url, You can use a tool, here

Interaction

Here is the URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = interact & query = #QUERY#

Message

Here is the URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = message & category = #CATEGORY#&message=#MESSAGE#

Object

Here is the URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = object

Returns in json the list of all Jeedom objects

Equipment

Here is the URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = eqLogic & object_id = #OBJECT_ID#

Ordered

Here is the URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = command & eqLogic_id = #EQLOGIC_ID#

Full Data

Here is the URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = fullData

Returns all objects, equipment, commands (and their value if this are infos) in json

Variable

Here is the URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = variable & name = #NAME#&value=Value

Nous utilisons des cookies pour vous garantir la meilleure expérience sur notre site web. Si vous continuez à utiliser ce site, nous supposerons que vous en êtes satisfait.