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
Pong zurückgeben, Kommunikation mit Jeedom testen
Gibt die Version von Jeedom zurück
Gibt die Jeedom-Datumszeit in Mikrosekunden zurück
Gibt einen Konfigurationswert zurück.
Einstellungen :
String-Schlüssel : Konfigurationswertschlüssel, der zurückgegeben werden soll
String Plugin : (optional), Konfigurationswert-Plugin
Zeichenfolge Standard : (optional), Wert, der zurückgegeben werden soll, wenn der Schlüssel nicht vorhanden ist pas
Speichert einen Konfigurationswert
Einstellungen :
Zeichenfolgenwert : Wert aufzuzeichnen
String-Schlüssel : Konfigurationswertschlüssel zum Speichern
String Plugin : (optional), Konfigurationswert Plugin zu enregistrer
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 :
Gibt die Liste aller Plugins zurück
Einstellungen :
int activOnly = 0 (gibt nur die Liste der aktivierten Plugins zurück)
int orderByCaterogy = 0 (gibt die Liste der sortierten Plugins zurück nach Kategorie)
Gibt die Liste aller Objekte zurück
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)
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 :
Gibt das angegebene Objekt zurück
Einstellungen:
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)
Gibt das angegebene Objekt zurück
Einstellungen:
int id (leer, wenn es sich um eine Kreation handelt)
Zeichenfolgenname
int Vater_id = null
int isVisible = 0
int position
Array-Konfiguration
Array-Anzeige
Gibt die globale Zusammenfassung für den im Parameter übergebenen Schlüssel zurück
Einstellungen:
Gibt die Zusammenfassung für die Objekt-ID zurück
Einstellungen:
int id : Objekt-ID
String-Schlüssel : (optional), Schlüssel der gewünschten Zusammenfassung, wenn leer, dann Jeedom sendet Ihnen die Zusammenfassung aller Schlüssel
Gibt die Liste aller Geräte zurück
Gibt Geräte und ihre Befehle sowie deren Status zurück (für Info-Befehle)
Einstellungen:
Gibt das angegebene Gerät zurück
Einstellungen:
Gibt alle Geräte zurück, die zum angegebenen Typ gehören (Plugin)
Einstellungen:
Gibt alle Geräte zurück, die zum angegebenen Objekt gehören
Einstellungen:
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:
string \ [] eqType = Tabelle der erforderlichen Gerätetypen
int \ [] id = Tabelle der gewünschten benutzerdefinierten Geräte-IDs
Gibt das registrierte / erstellte Gerät zurück
Einstellungen:
int id (leer, wenn es sich um eine Kreation handelt)
Zeichenfolge eqType_name (Skripttyp, virtuelle Ausrüstung…)
Zeichenfolgenname
Zeichenfolge logische ID = ‘’
int object_id = null
int eqReal_id = null
int isVisible = 0
int isEnable = 0
Array-Konfiguration
int timeout
Array-Kategorie
Gibt die Liste aller Befehle zurück
Gibt den angegebenen Befehl zurück
Einstellungen:
Gibt alle Bestellungen zurück, die zum angegebenen Gerät gehören
Einstellungen:
Führen Sie den angegebenen Befehl aus
Einstellungen:
int id : ID eines Befehls oder ID-Arrays, wenn Sie ausführen möchten mehrere Bestellungen gleichzeitig
\ [Optionen ] Liste der Befehlsoptionen (abhängig von Typ und Befehlssubtyp)
Gibt Statistiken zur Bestellung zurück (funktioniert nur bei Infos und historische Befehle)
Einstellungen:
int id
Zeichenfolge startTime : Startdatum der Statistikberechnung
Zeichenfolge endTime : Enddatum der Statistikberechnung
Gibt den Trend für den Befehl zurück (funktioniert nur für die Befehle von Info und historischer Typ)
Einstellungen:
int id
Zeichenfolge startTime : Startdatum der Trendberechnung
Zeichenfolge endTime : Enddatum der Trendberechnung
Gibt den Befehlsverlauf zurück (funktioniert nur mit den Befehlen von Info und historischer Typ)
Einstellungen:
int id
Zeichenfolge startTime : Startdatum der Geschichte
Zeichenfolge endTime : Enddatum der Geschichte
Gibt das angegebene Objekt zurück
Einstellungen:
int id (leer, wenn es sich um eine Kreation handelt)
Zeichenfolgenname
Zeichenfolge logische ID
Zeichenfolge eqType
Zeichenfolgenreihenfolge
Zeichenfolgentyp
String-Subtyp
int eqLogic_id
int isHistorized = 0
String-Einheit = ‘’
Array-Konfiguration
Array-Vorlage
Array-Anzeige
Array HTML
int value = null
int isVisible = 1
Array-Alarm
Ermöglicht das Senden eines Werts an eine Bestellung
Einstellungen:
int id
Zeichenfolgenwert : valeur
Zeichenfolge datetime : (optional) Datum / Uhrzeit-Wert
Gibt die Liste aller Szenarien zurück
Gibt das angegebene Szenario zurück
Einstellungen:
Gibt den Export des Szenarios sowie den menschlichen Namen des Szenarios zurück
Einstellungen:
Ermöglicht das Importieren eines Szenarios.
Einstellungen:
int id : ID des zu importierenden Szenarios (leer bei Erstellung)
Zeichenfolge humanName : menschlicher Name des Szenarios (leer bei Erstellung)
Array-Import : Szenario (aus dem Feld Exportszenario::export)
Ändert den Status des angegebenen Szenarios.
Einstellungen:
int id
Zeichenfolgenstatus: \ [Run, Stop, aktivieren, deaktivieren ]
Ermöglicht das Wiederherstellen eines Protokolls
Einstellungen:
Zeichenfolgenprotokoll : Name des wiederherzustellenden Protokolls
String-Start : Zeilennummer, auf der mit dem Lesen begonnen werden soll
Zeichenfolge nbLine : Anzahl der wiederherzustellenden Zeilen
Holen Sie sich die Jeedom-Protokollliste
Einstellungen:
Leeren Sie ein Protokoll
Einstellungen:
Ermöglicht das Löschen eines Protokolls
Einstellungen:
Ruft den Wert einer im Datenspeicher gespeicherten Variablen ab
Einstellungen:
Zeichenfolgentyp : Art des gespeicherten Werts (für Szenarien Es ist ein Szenario)
id linkId : -1 für global (Wert für Standardszenarien, oder die Szenario-ID)
String-Schlüssel : Wertname
Speichert den Wert einer Variablen im Datenspeicher
Einstellungen:
Zeichenfolgentyp : Art des gespeicherten Werts (für Szenarien Es ist ein Szenario)
id linkId : -1 für global (Wert für Standardszenarien, oder die Szenario-ID)
String-Schlüssel : Wertname
gemischter Wert : Wert aufzuzeichnen
Gibt die Liste aller Nachrichten zurück
Löschen Sie alle Nachrichten
Versuchen Sie, eine Anforderung mit einer Interaktion abzugleichen, und führen Sie sie aus Aktion und reagiert entsprechend
Einstellungen:
Abfrage (Anforderungsphrase)
int reply_cmd = NULL : Befehls-ID, die zum Antworten verwendet werden soll, Wenn nicht angegeben, sendet Jeedom Ihnen die Antwort im JSON
Gibt die vollständige Liste aller Interaktionen zurück
Stoppen Sie Jeedom
Starten Sie Jeedom neu
Lässt Sie wissen, ob der globale Zustand von Jeedom in Ordnung ist
Starten wir ein Jeedom-Update
Ermöglicht das Starten eines Backups von Jeedom
Liste der USB-Anschlüsse und Namen der daran angeschlossenen USB-Sticks
Installation / Update eines bestimmten Plugins
Einstellungen:
Löschen eines bestimmten Plugins
Einstellungen:
Gibt Informationen zum Status von Plugin-Abhängigkeiten zurück
Einstellungen:
Erzwingen Sie die Installation von Plugin-Abhängigkeiten
Einstellungen:
Gibt Informationen zum Status des Plugin-Daemons zurück
Einstellungen:
Zwinge den Dämon zu starten
Einstellungen:
Dämonenstopp erzwingen
Einstellungen:
Ändern Sie den Verwaltungsmodus des Dämons
Einstellungen:
String-Plugin_id : Plugin-Name (logischer Name)
int-Modus : 1 für automatisch, 0 für manuell
Geben Sie die Liste aller installierten Komponenten, deren Version und die zurück verwandte Informationen
Ermöglicht die Suche nach Updates
Ermöglicht das Aktualisieren von Jeedom und allen Plugins
Einstellungen:
Erzwingen Sie den (Neustart) des Jeedom DNS
Erzwingt das Anhalten des DNS Jeedom
Gibt den Jeedom DNS-Status zurück
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)