Hier finden Sie eine Dokumentation zu API-Methoden. Zuerst ist hier die Spezifikationen (JSON RPC 2.0) : http://www.jsonrpc.org/specification

Der Zugriff auf die API erfolgt über die URL : URL_JEEDOM/core/api/jeeApi.php

Divers

ping

Pong zurückgeben, Kommunikation mit Jeedom testen

version

Gibt die Version von Jeedom zurück

datetime

Gibt die Jeedom-Datumszeit in Mikrosekunden zurück

Konfigurations-API

config::byKey

Gibt einen Konfigurationswert zurück.

Einstellungen :

config::save

Speichert einen Konfigurationswert

Einstellungen :

JSON-Ereignis-API

event::changes

Gibt die Liste der Änderungen seit der im Parameter übergebenen Datum / Uhrzeit zurück (muss in Mikrosekunden sein). Sie haben auch in der Antwort die Jeedom’s aktuelle Datumszeit (wird für die nächste Abfrage wiederverwendet)

Einstellungen :

JSON Plugin API

plugin::listPlugin

Gibt die Liste aller Plugins zurück

Einstellungen :

Objekt-JSON-API

object::all

Gibt die Liste aller Objekte zurück

object::full

Gibt die Liste aller Objekte zurück, wobei für jedes Objekt alle seine Ausrüstung und für jede Ausrüstung alle ihre Befehle sowie Zustände von diesen (für Befehle vom Typ Info)

object::fullById

Gibt ein Objekt mit seiner gesamten Ausrüstung und für jede Ausrüstung zurück alle seine Befehle sowie ihre Zustände (z Info-Typ-Befehle)

Einstellungen :

object::byId

Gibt das angegebene Objekt zurück

Einstellungen:

object::fullById

Gibt ein Objekt, seine Ausrüstung und für jede Ausrüstung alle seine zurück Befehle sowie die Zellenzustände (für Typbefehle info)

object::save

Gibt das angegebene Objekt zurück

Einstellungen:

JSON-Zusammenfassungs-API

summary::global

Gibt die globale Zusammenfassung für den im Parameter übergebenen Schlüssel zurück

Einstellungen:

summary::byId

Gibt die Zusammenfassung für die Objekt-ID zurück

Einstellungen:

JSON EqLogic API

eqLogic::all

Gibt die Liste aller Geräte zurück

eqLogic::fullById

Gibt Geräte und ihre Befehle sowie deren Status zurück (für Info-Befehle)

Einstellungen:

eqLogic::byId

Gibt das angegebene Gerät zurück

Einstellungen:

eqLogic::byType

Gibt alle Geräte zurück, die zum angegebenen Typ gehören (Plugin)

Einstellungen:

eqLogic::byObjectId

Gibt alle Geräte zurück, die zum angegebenen Objekt gehören

Einstellungen:

eqLogic::byTypeAndId

Gibt eine Gerätetabelle gemäß den Parametern zurück. Die Rückkehr wird vom Formulararray sein ('eqType1' ⇒array ('id'⇒…,' cmds '⇒ Array (….)), 'eqType2' ⇒array ('id'⇒…,' cmds '⇒ Array (….))….,id1 ⇒ Array ('id'⇒…,' cmds '⇒ Array (….)), id2 ⇒ Array (' id'⇒…, 'cmds' ⇒ array(…​.))..)

Einstellungen:

eqLogic::save

Gibt das registrierte / erstellte Gerät zurück

Einstellungen:

JSON Cmd API

cmd::all

Gibt die Liste aller Befehle zurück

cmd::byId

Gibt den angegebenen Befehl zurück

Einstellungen:

cmd::byEqLogicId

Gibt alle Bestellungen zurück, die zum angegebenen Gerät gehören

Einstellungen:

cmd::execCmd

Führen Sie den angegebenen Befehl aus

Einstellungen:

cmd::getStatistique

Gibt Statistiken zur Bestellung zurück (funktioniert nur bei Infos und historische Befehle)

Einstellungen:

cmd::getTendance

Gibt den Trend für den Befehl zurück (funktioniert nur für die Befehle von Info und historischer Typ)

Einstellungen:

cmd::getHistory

Gibt den Befehlsverlauf zurück (funktioniert nur mit den Befehlen von Info und historischer Typ)

Einstellungen:

cmd::save

Gibt das angegebene Objekt zurück

Einstellungen:

cmd::event

Ermöglicht das Senden eines Werts an eine Bestellung

Einstellungen:

JSON-Szenario-API

scenario::all

Gibt die Liste aller Szenarien zurück

scenario::byId

Gibt das angegebene Szenario zurück

Einstellungen:

scenario::export

Gibt den Export des Szenarios sowie den menschlichen Namen des Szenarios zurück

Einstellungen:

scenario::import

Ermöglicht das Importieren eines Szenarios.

Einstellungen:

scenario::changeState

Ändert den Status des angegebenen Szenarios.

Einstellungen:

JSON-Protokoll-API

log::get

Ermöglicht das Wiederherstellen eines Protokolls

Einstellungen:

log::list

Holen Sie sich die Jeedom-Protokollliste

Einstellungen:

log::empty

Leeren Sie ein Protokoll

Einstellungen:

log::remove

Ermöglicht das Löschen eines Protokolls

Einstellungen:

JSON-Datenspeicher-API (Variable)

datastore::byTypeLinkIdKey

Ruft den Wert einer im Datenspeicher gespeicherten Variablen ab

Einstellungen:

datastore::save

Speichert den Wert einer Variablen im Datenspeicher

Einstellungen:

JSON-Nachrichten-API

message::all

Gibt die Liste aller Nachrichten zurück

message::removeAll

Löschen Sie alle Nachrichten

JSON-Interaktions-API

interact::tryToReply

Versuchen Sie, eine Anforderung mit einer Interaktion abzugleichen, und führen Sie sie aus Aktion und reagiert entsprechend

Einstellungen:

interactQuery::all

Gibt die vollständige Liste aller Interaktionen zurück

JSON-System-API

jeedom::halt

Stoppen Sie Jeedom

jeedom::reboot

Starten Sie Jeedom neu

jeedom::isOk

Lässt Sie wissen, ob der globale Zustand von Jeedom in Ordnung ist

jeedom::update

Starten wir ein Jeedom-Update

jeedom::backup

Ermöglicht das Starten eines Backups von Jeedom

jeedom::getUsbMapping

Liste der USB-Anschlüsse und Namen der daran angeschlossenen USB-Sticks

JSON Plugin API

plugin::install

Installation / Update eines bestimmten Plugins

Einstellungen:

plugin::remove

Löschen eines bestimmten Plugins

Einstellungen:

plugin::dependancyInfo

Gibt Informationen zum Status von Plugin-Abhängigkeiten zurück

Einstellungen:

plugin::dependancyInstall

Erzwingen Sie die Installation von Plugin-Abhängigkeiten

Einstellungen:

plugin::deamonInfo

Gibt Informationen zum Status des Plugin-Daemons zurück

Einstellungen:

plugin::deamonStart

Zwinge den Dämon zu starten

Einstellungen:

plugin::deamonStop

Dämonenstopp erzwingen

Einstellungen:

plugin::deamonChangeAutoMode

Ändern Sie den Verwaltungsmodus des Dämons

Einstellungen:

JSON-Update-API

update::all

Geben Sie die Liste aller installierten Komponenten, deren Version und die zurück verwandte Informationen

update::checkUpdate

Ermöglicht die Suche nach Updates

update::update

Ermöglicht das Aktualisieren von Jeedom und allen Plugins

update::doUpdate

Einstellungen:

JSON-Netzwerk-API

network::restartDns

Erzwingen Sie den (Neustart) des Jeedom DNS

network::stopDns

Erzwingt das Anhalten des DNS Jeedom

network::dnsRun

Gibt den Jeedom DNS-Status zurück

JSON-API-Beispiele

Hier ist ein Beispiel für die Verwendung der API. Für das folgende Beispiel Ich benutze diese Klasse php Dies vereinfacht die Verwendung der API.

Abrufen der Objektliste :

`{.php} $jsonrpc = new jsonrpcClient('#URL_JEEDOM#/core/api/jeeApi.php', #API_KEY#); if ($ jsonrpc-> sendrequest ( ‚Objekt::all ', Array())){ print_r ($ jsonrpc-> getResult ()); }else{ echo $ jsonrpc-> getError (); } ‘’

Ausführung eines Auftrags (mit der Option eines Titels und einer Nachricht)

`{.php} $jsonrpc = new jsonrpcClient('#URL_JEEDOM#/core/api/jeeApi.php', #API_KEY#); if ($ jsonrpc-> sendrequest ( ‚cmd::execCmd ', array (' id' => #cmd_id#, 'options '=> array (' title '=>' Cuckoo ',' message '=>' Es funktioniert')))){ Echo 'OK'; }else{ echo $ jsonrpc-> getError (); } ‘’

Die API kann natürlich auch in anderen Sprachen verwendet werden (einfach ein Beitrag auf einer Seite)

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.