Jeedom provides developers and users with a complete API so that they can control Jeedom from any connected object.
Two APIs are available : a developer-oriented JSON RPC 2 pilot.0 and another via URL and HTTP request.
This API is very easy to use by simple HTTP requests via URL.
Note
For all of this documentation, #IP_JEEDOM# corresponds to your Jeedom access url. This is (unless you are connected to your local network) the internet address that you use to access Jeedom from outside.
Note
For all of this documentation, #API_KEY# corresponds to your API key, specific to your installation. To find it, go to the “General” menu → “Configuration” → “General” tab”.
Vohere l’URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = scenario & id = #ID#&action=#ACTION#
Vohere l’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 page Analysis → Home automation summary, to search for the command then to open its advanced configuration (the “gear” icon) and there, you will see a URL which already contains everything you need depending on the type and subtype of the command.
Note
It is possible for the field #ID# place multiple commands 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 urls, You can use a tool, here.
Vohere l’URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = interact & query = #QUERY#
Vohere l’URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = message & category = #CATEGORY#&message=#MESSAGE#
Vohere l’URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = object
Returns in json the list of all Jeedom objects.
Vohere l’URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = eqLogic & object_id = #OBJECT_ID#
Vohere l’URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = command & eqLogic_id = #EQLOGIC_ID#
Vohere l’URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = fullData
Returns all objects, equipment, commands (and their value if they are info) in json.
Vohere l’URL = http://#IP_JEEDOM#/core/api/jeeApi.php?apikey=#APIKEY#& type = variable & name = #NAME#&value=VALUE