Benutzer-Werkzeuge

Webseiten-Werkzeuge


develop:xmlrpc

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung
Vorhergehende Überarbeitung
develop:xmlrpc [d.m.Y H:i]
willuhn
develop:xmlrpc [d.m.Y H:i] (aktuell)
willuhn [Java]
Zeile 14: Zeile 14:
 ==== Java ==== ==== Java ====
  
-Wir benötigen [[http://www.java.com/de/|SUN Java]] in Version 6 (oft auch "1.6" bezeichnet) oder höher. Die Verwendung von Java-Versionen anderer Hersteller (z.Bsp. IBM Java, GNU GCJ/Classpath, OpenJDK, usw.) wird nicht empfohlen, da auf diesen Plattformen keine Tests durchgeführt wurden.+Du benötigst Java oder höher. Lade die aktuelle Version von https://adoptopenjdk.netherunter und installiere sie. 
  
  
 ==== Jameica und Plugins ==== ==== Jameica und Plugins ====
  
-Wir benötigen folgende Komponenten:+Folgende Komponenten werden benötigt:
  
-^ Name             ^ Version ^ Download ^ +^ Name             ^ Download ^ 
-| jameica          | 1.10 oder höher | [[http://www.willuhn.de/projects/jameica/download.php]] | +| jameica          | [[http://www.willuhn.de/products/jameica/download.php]] | 
-| jameica.webadmin | 1.2 oder höher  | [[http://www.willuhn.de/projects/jameica/download_ext.php]] | +| jameica.webadmin | [[http://www.willuhn.de/products/jameica/download_ext.php]] | 
-| jameica.xmprpc   | 1.1 oder höher  | [[http://www.willuhn.de/projects/jameica/download_ext.php]] | +| jameica.xmlrpc   | [[http://www.willuhn.de/products/jameica/download_ext.php]] | 
-| hibiscus         | 1.12 oder höher | [[http://www.willuhn.de/projects/hibiscus/download.php]] | +| hibiscus         | [[http://www.willuhn.de/products/hibiscus/download.php]] | 
-| hibiscus.xmlrpc  | 1.2 oder höher  | [[http://www.willuhn.de/projects/hibiscus/download_ext.php]] |+| hibiscus.xmlrpc  | [[http://www.willuhn.de/products/hibiscus/download_ext.php]] |
  
 Das Plugin "jameica.webadmin" erweitert Jameica um Webfunktionalität mithilfe eines embedded Webservers ([[http://jetty.mortbay.org/jetty/index.html|Jetty]]). "jameica.xmlrpc" setzt auf diesen Webserver auf und erweitert ihn um XML-RPC-Fähigkeiten. Neben Hibiscus selbst wird nun noch "hibiscus.xmlrpc" benötigt, welches die Hibiscus-Daten via XML-RPC bereitstellt. Das Plugin "jameica.webadmin" erweitert Jameica um Webfunktionalität mithilfe eines embedded Webservers ([[http://jetty.mortbay.org/jetty/index.html|Jetty]]). "jameica.xmlrpc" setzt auf diesen Webserver auf und erweitert ihn um XML-RPC-Fähigkeiten. Neben Hibiscus selbst wird nun noch "hibiscus.xmlrpc" benötigt, welches die Hibiscus-Daten via XML-RPC bereitstellt.
  
 +**Hinweis** Der [[http://willuhn.de/products/hibiscus-server|Hibiscus Payment-Server]] enthält bereits alle benötigten Komponenten. Beachte hier jedoch, dass das eine reine Server-Anwendung ist, die nicht über die grafische Benutzer-Oberfläche bedient werden kann sondern nur über das Webfrontend unter [[https://<server>:8080/hibiscus]]. Alle folgenden Hinweise, die sich auf die grafische Benutzer-Oberfläche von Hibiscus/Jameica beziehen, gelten für den Payment-Server nicht. Hier werden alle Aktionen stattdessen über das genannte Web-Frontend ausgeführt.
  
 ===== Installation ===== ===== Installation =====
  
-Jameica und Hibiscus können wie gehabt [[support:install|installiert]] werden. Die zusätzlichen Plugins "jameica.webadmin", "jameica.xmlrpc" und "hibiscus.xmlrpc" entpacken wir nun ebenfalls (wie Hibiscus auch) im Verzeichnis "plugins". Fertig. +Jameica und Hibiscus können wie gehabt [[handbuch:sonstiges:install|installiert]] werden. Entpacke die zusätzlichen Plugins "jameica.webadmin", "jameica.xmlrpc" und "hibiscus.xmlrpc" anschließend ebenfalls (wie Hibiscus auch) im Verzeichnis "plugins". Fertig.
- +
  
 ===== Erster Start ===== ===== Erster Start =====
Zeile 42: Zeile 41:
 Jameica wird wie gewohnt gestartet (mit jameica.sh, jameica-win32.exe, etc.) . Sollten hierbei bereits Fehler auftreten, ist die häufigste Ursache ein Versionskonflikt zwischen den verwendeten Plugins. Bitte beachte die oben angegebenen Versionsnummern. Jameica wird wie gewohnt gestartet (mit jameica.sh, jameica-win32.exe, etc.) . Sollten hierbei bereits Fehler auftreten, ist die häufigste Ursache ein Versionskonflikt zwischen den verwendeten Plugins. Bitte beachte die oben angegebenen Versionsnummern.
  
-Richten Sie nun wie gewohnt ein Sicherheitsmedium (Chipkarte, PIN/TAN oder Schlüsseldiskette) ein und legen Sie Ihre Konten an.  Folgen Sie hierbei der [[support:install#erste_schritte_konfiguration|Installations-Anleitung]] (Schritt "Erste Schritte / Konfiguration").+Richte nun wie gewohnt ein Sicherheitsmedium (Chipkarte, PIN/TAN oder Schlüsseldiskette) ein und lege die Konten an.
  
 ===== XML-RPC-Services aktivieren ===== ===== XML-RPC-Services aktivieren =====
  
-Wir klicken oben im Menu auf "Datei>Einstellungen". Hier werden nun zwei zusätzliche Reiter ("Tabs") angezeigt.+Klicke oben im Menu auf "Datei>Einstellungen". Hier werden nun zwei zusätzliche Reiter ("Tabs") angezeigt.
  
-Auf dem Reiter "HTTP" können wir den TCP-Port einstellen, über den wir anschließend auf den XML-RPC-Service zugreifen. Weiterhin kann der Zugriff mittels SSL (also HTTPS) verschlüsselt und durch Authentifizierung mittels Master-Passwort geschützt werden.+Auf dem Reiter "HTTP" kann ein abweichender TCP-Port eingestellt werden, über den anschließend auf den XML-RPC-Service zugegriffen werden kann. Weiterhin kann der Zugriff mittels SSL (also HTTPS) verschlüsselt und durch Authentifizierung mittels Master-Passwort geschützt werden.
  
 <code>Sicherheitshinweis: HTTPS und Authentifizierung mittels Master-Passwort sollte nur zum Testen deaktiviert werden!</code> <code>Sicherheitshinweis: HTTPS und Authentifizierung mittels Master-Passwort sollte nur zum Testen deaktiviert werden!</code>
  
-Wir öffnen nun den Reiter "XML-RPC". Lediglich die folgenden Services müssen aktiviert werden, um Zugriff via XML-RPC zu erhalten.+Öffnen den Reiter "XML-RPC". Lediglich die folgenden Services müssen aktiviert werden, um Zugriff via XML-RPC zu erhalten. 
 + 
 +^ Plugin          ^ Service                ^ Beschreibung ^ 
 +| hibiscus.xmlrpc | address                | Abfragen, Anlegen und Löschen von Adressen im Adressbuch | 
 +| hibiscus.xmlrpc | konto                  | Zugriff auf die Liste der Konten und Salden | 
 +| hibiscus.xmlrpc | umsatz                 | Abfragen der Kontoauszüge | 
 +| hibiscus.xmlrpc | sepaueberweisung       | Abrufen, Erstellen und Löschen von SEPA-Überweisungen | 
 +| hibiscus.xmlrpc | sepalastschrift        | Abrufen, Erstellen und Löschen von SEPA-Lastschriften | 
 +| hibiscus.xmlrpc | sepasammelueberweisung | Abrufen, Erstellen und Löschen von SEPA-Sammel-Überweisungen | 
 +| hibiscus.xmlrpc | sepasammellastschrift  | Abrufen, Erstellen und Löschen von SEPA-Sammel-Lastschriften |
  
-^ Plugin          ^ Service      ^ Beschreibung ^ 
-| hibiscus.xmlrpc | address            | Abfragen, Anlegen und Löschen von Adressen im Adressbuch | 
-| hibiscus.xmlrpc | konto              | Zugriff auf die Liste der Konten und Salden | 
-| hibiscus.xmlrpc | umsatz             | Abfragen der Kontoauszüge | 
-| hibiscus.xmlrpc | ueberweisung       | Abrufen, Erstellen und Löschen von Überweisungen | 
-| hibiscus.xmlrpc | lastschrift        | Abrufen, Erstellen und Löschen von Lastschriften | 
-| hibiscus.xmlrpc | sammelueberweisung | Abrufen, Erstellen und Löschen von Sammel-Überweisungen | 
-| hibiscus.xmlrpc | sammellastschrift  | Ermöglicht das Abrufen und Erstellen von Sammel-Lastschriften | 
  
 Alternativ können die XML-RPC-Services auch manuell in der Konfigurations-Datei cfg/de.willuhn.jameica.xmlrpc.Plugin.properties (im [[support:backup#benutzerverzeichnis|Benutzerverzeichnis]]) durch Hinzufügen folgender Zeilen aktiviert werden: Alternativ können die XML-RPC-Services auch manuell in der Konfigurations-Datei cfg/de.willuhn.jameica.xmlrpc.Plugin.properties (im [[support:backup#benutzerverzeichnis|Benutzerverzeichnis]]) durch Hinzufügen folgender Zeilen aktiviert werden:
Zeile 68: Zeile 68:
   hibiscus.xmlrpc.konto.shared=true   hibiscus.xmlrpc.konto.shared=true
   hibiscus.xmlrpc.umsatz.shared=true   hibiscus.xmlrpc.umsatz.shared=true
-  hibiscus.xmlrpc.ueberweisung.shared=true +  hibiscus.xmlrpc.sepaueberweisung.shared=true 
-  hibiscus.xmlrpc.lastschrift.shared=true +  hibiscus.xmlrpc.sepalastschrift.shared=true 
-  hibiscus.xmlrpc.sammellastschrift.shared=true +  hibiscus.xmlrpc.sepasammelueberweisung.shared=true 
-  hibiscus.xmlrpc.sammelueberweisung.shared=true+  hibiscus.xmlrpc.sepasammellastschrift.shared=true
  
 ===== Konfiguration prüfen ===== ===== Konfiguration prüfen =====
  
-Wir beenden Hibiscus und starten die Anwendung nun neu. In der Log-Datei "jameica.log" im [[support:backup#benutzerverzeichnis|Benutzerverzeichnis]] werden nun die URLs der aktivierten Services angezeigt. Beispiel:+Beende Hibiscus und starte die Anwendung nun neu. In der Log-Datei "jameica.log" im [[support:backup#benutzerverzeichnis|Benutzerverzeichnis]] werden nun die URLs der aktivierten Services angezeigt. Beispiel:
  
   [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] XML-RPC-Services   [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] XML-RPC-Services
Zeile 81: Zeile 81:
   [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.konto   [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.konto
   [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.umsatz   [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.umsatz
-  [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.ueberweisung +  [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sepaueberweisung 
-  [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.lastschrift +  [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sepalastschrift 
-  [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sammellastschrift +  [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sepasammelueberweisung 
-  [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sammelueberweisung+  [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage]    * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sepasammellastschrift
  
  
Zeile 90: Zeile 90:
 ===== (optional) Hibiscus ohne GUI starten ===== ===== (optional) Hibiscus ohne GUI starten =====
  
-Wenn Sie Hibiscus auf einem Server verwenden wollen und keine grafische Benutzeroberfläche benötigenkönnen Sie das Jameica-Startscript mit den Parametern "-d" (um die GUI nicht zu starten) und "-p <Master-Passwort" (um das Master-Passwort bereits beim Start zu übergeben) ausführen. Alle Log-Ausgaben erscheinen zusätzlich auf der Konsole. Öffnen Sie hierzu eine Shell (Linux), ein Terminal (MacOS) oder eine DOS-Eingabeaufforderung (Windows), wechseln Sie in das Programmverzeichnis von Jameica und geben starten Sie Hibiscus wie folgt:+Wenn du Hibiscus auf einem Server verwenden willst und keine grafische Benutzeroberfläche benötigstkannst Du das Jameica-Startscript mit den Parametern "-d" (um die GUI nicht zu starten) und "-p <Master-Passwort" (um das Master-Passwort bereits beim Start zu übergeben) ausführen. Alle Log-Ausgaben erscheinen zusätzlich auf der Konsole. Öffne hierzu eine Shell (Linux), ein Terminal (MacOS) oder eine DOS-Eingabeaufforderung (Windows), wechsle in das Programmverzeichnis von Jameica und starte Hibiscus wie folgt:
  
-^ Betriebssystem        ^ Kommando                                   +^ Betriebssystem        ^ Kommando                                                                                        
-| Windows               | jameica-win32.exe -d -p <Master-Passwort>  +| Windows               | jameica-win32.exe -d -p <Master-Passwort> (beim Payment-Server stattdessen "jameicaserver.exe"
-| Linux                 | ./jameica.sh -d -p <Master-Passwort>       +| Linux                 | ./jameica.sh -d -p <Master-Passwort>  (beim Payment-Server stattdessen "jameicaserver.sh"     
-| MacOS                 | ./jameica-macos.sh -d                      |+| MacOS                 | ./jameica-macos.sh -d                                                                           |
  
 Hinweise: Hinweise:
  
   * Das Übergeben des Master-Passwortes wird für MacOS nicht unterstützt.   * Das Übergeben des Master-Passwortes wird für MacOS nicht unterstützt.
-  * Für Linux können Sie auch das Init-Script "rcjameica" zum Starten und Beenden verwenden. Es ist für OpenSuSE Linux vorbereitet, kann von Ihnen jedoch auch leicht an Ihre Distribution angepasst werden. +  * Für Linux kann auch das Init-Script "rcjameica" zum Starten und Beenden verwendet werden. Es ist zwar für OpenSuSE Linux vorbereitet, kann jedoch auch an andere Distributionen angepasst werden.
- +
-Alternativ können Sie Hibiscus natürlich auch wie gewohnt mit Benutzeroberfläche starten. Der Zugriff auf die XML-RPC-Services funktioniert auch in diesem Betriebsmodus. +
  
  
Zeile 118: Zeile 115:
   * [[develop:xmlrpc:sammelauftrag|Sammel-Überweisungen und -Lastschriften]]   * [[develop:xmlrpc:sammelauftrag|Sammel-Überweisungen und -Lastschriften]]
  
 +**Tipp**: Für PHP gibt es unter https://github.com/willuhn/hibiscus.php bereits "gebrauchsfertigen" Code.\\ 
 +**Tipp**: Ein Java-Beispiel findet sich unter http://www.zephyrsoft.org/hibiscus-watcher (Maven-Projekt).
 ===== Verhalten der Services anpassen ===== ===== Verhalten der Services anpassen =====
 +
 +==== Quoting aktivieren/deaktivieren ====
 +
 +  * Konfigurationsdatei: [[support:backup#benutzerverzeichnis|.jameica]]/cfg/de.willuhn.jameica.hbci.xmlrpc.Plugin.properties
 +  * Name des Parameters: quoting.char=<Wert>
 +  * Default-Wert: <keiner>
 +
 +Einige XML-RPC-Funktionen liefern Listen als Rückgabe-Werte, deren Zeilen durch Doppelpunkt getrennte Spalten enthalten (z.Bsp: [[develop:xmlrpc:umsatz#liste_der_umsaetze_ermitteln_veraltet|Liste der Umsätze (veraltet)]], [[develop:xmlrpc:konto#liste_der_konten_ermitteln_veraltet|Liste der Konten (veraltet)]] oder [[develop:xmlrpc:einzelauftrag#liste_der_auftraege_ermitteln_veraltet|Liste der Aufträge (veraltet)]]). Die einzelnen Werte der Spalten können optional mit einem beliebigen Quoting-Zeichen - z.Bsp <"> umschlossen werden - für den Fall, dass Werte existieren, die Doppelpunkte enthalten (welcher ja bereits als Spaltentrenner verwendet wird.
 +
 +Beispiel:
 +
 +  quoting.char="
 +
 +
 +==== Ergebnisliste einschränken ====
 +
 +  * Konfigurationsdatei: [[support:backup#benutzerverzeichnis|.jameica]]/cfg/de.willuhn.jameica.hbci.xmlrpc.Plugin.properties
 +  * Name des Parameters: xmlrpc.result.limit=<Wert>
 +  * Default-Wert: 10000
 +
 +Einige XML-RPC-Funktionen liefern Rückgabe-Werte in Listenform (z.Bsp. [[develop:xmlrpc:umsatz#liste_der_umsaetze_ermitteln|Liste der Umsätze]], [[develop:xmlrpc:konto#liste_der_konten_ermitteln|Liste der Konten]] oder [[develop:xmlrpc:einzelauftrag#liste_der_auftraege_ermitteln|Liste der Aufträge]]). Abhängig von der Anzahl der Zeilen können diese Listen bei der Erstellung sehr viel Speicher verbrauchen. Mit dem Parameter kann die maximale Anzahl von zurückzuliefernden Zeilen beschränkt werden.
 +
  
 ==== NULL-Support aktivieren/deaktivieren ==== ==== NULL-Support aktivieren/deaktivieren ====
Zeile 129: Zeile 149:
 Der XML-RPC-Standard unterstützt eigentlich keinen [[http://de.wikipedia.org/wiki/XML-RPC#Null-Datentyp|NULL-Datentyp]]. Es existiert jedoch eine [[http://ontosys.com/xml-rpc/extensions.php|Protokoll-Erweiterung]], die NULL-Werte in Form des Elementes "<nil/>" bzw. "<ex:nil/>" zulässt. Die [[http://ws.apache.org/xmlrpc/types.html|Apache-Implementierung]] unterstützt dies beispielsweise. Da NULL-/NUL- bzw. NIL-Werte in verschiedenen Programmiersprachen jedoch Probleme verursachen können, kann das Verhalten des Plugins "hibiscus.xmlrpc" mit diesem Parameter beeinflusst werden.  Der XML-RPC-Standard unterstützt eigentlich keinen [[http://de.wikipedia.org/wiki/XML-RPC#Null-Datentyp|NULL-Datentyp]]. Es existiert jedoch eine [[http://ontosys.com/xml-rpc/extensions.php|Protokoll-Erweiterung]], die NULL-Werte in Form des Elementes "<nil/>" bzw. "<ex:nil/>" zulässt. Die [[http://ws.apache.org/xmlrpc/types.html|Apache-Implementierung]] unterstützt dies beispielsweise. Da NULL-/NUL- bzw. NIL-Werte in verschiedenen Programmiersprachen jedoch Probleme verursachen können, kann das Verhalten des Plugins "hibiscus.xmlrpc" mit diesem Parameter beeinflusst werden. 
  
-Einige Funktionen des Plugins (insb. Funktionen zum Erstellen neuer Adressen oder Aufträge) liefern per Default im Erfolgsfall NULL zurück und im Fehlerfall einen String mit dem Fehlertext. Falls jedoch die ID des erstellten Datensatzes benötigt wird oder die verwendete Programmiersprache auf Client-Seite keine NULL-Werte unterstützt, kann in die o.g. Datei eine Zeile "xmlrpc.supports.null=false" eingetragen werden. Die betreffenden Funktionen ändern dabei ihr Verhalten. Im Erfolgsfall liefern Sie die ID des erstellten/geänderten/gelöschten Datensatzes zurück. Im Fehlerfall werden sie eine Exception (Fault).+Einige Funktionen des Plugins (insb. Funktionen zum Erstellen neuer Adressen oder Aufträge) liefern per Default im Erfolgsfall NULL zurück und im Fehlerfall einen String mit dem Fehlertext. Falls jedoch die ID des erstellten Datensatzes benötigt wird oder die verwendete Programmiersprache auf Client-Seite keine NULL-Werte unterstützt, kann in die o.g. Datei eine Zeile "xmlrpc.supports.null=false" eingetragen werden. Die betreffenden Funktionen ändern dabei ihr Verhalten. Im Erfolgsfall liefern Sie die ID des erstellten/geänderten/gelöschten Datensatzes zurück. Im Fehlerfall werfen sie eine Exception (Fault).
  
 ^ Parameter-Wert             ^ Verhalten im Erfolgsfall ^ Verhalten im Fehlerfall ^ ^ Parameter-Wert             ^ Verhalten im Erfolgsfall ^ Verhalten im Fehlerfall ^


Impressum | Datenschutz
develop/xmlrpc.1297099010.txt.gz · Zuletzt geändert: d.m.Y H:i (Externe Bearbeitung)