api docs new geplante API Dokumentation

  1. 1. Einführung
  2. 2. Interfaces
    1. 2.1 XML-RPC
    2. 2.1 SOAP
    3. 2.2 XML
    4. 2.3 JSON
    5. 2.4 JSONP
    6. 2.5 PHP
  3. 3. Methoden
    1. 3.${key+1} ${method.title}

Einführung

Die Iro API enthält Funktion, die für den Massenversand nützlich sind.

Interfaces

Die Iro API wird über verschiedene Interfaces bereit gestellt, die unterschiedlich angesprochen werden, aber das selbe tun.

XML-RPC

Interface-URI: http://localhost:8000/xmlrpc

Die aufgerufene Methode wird dabei im <methodName /> übergeben.

SOAP

Interface-URI: http://localhost:8000/soap

Die aufgerufene Methode wird dabei im <methodName /> übergeben.

XML

Interface-URI: http://localhost:8000/xml/<methode>

Die aufgerufene Methode wird im Pfad der Interface-URI übergeben.

Parameter können via HTTP per GET oder POST im Format application/x-www-form-urlencoded übergeben werden.

Die Ausgabe erfolgt als XML Markup.

JSON

Interface-URI: http://localhost:8000/json/<methode>

Die aufgerufene Methode wird im Pfad der Interface-URI übergeben.

Parameter können via HTTP per GET oder POST im Format application/x-www-form-urlencoded oder JSON-Objekt übergeben werden.

Die Ausgabe erfolgt als JSON-Objekt.

JSONP

Interface-URI: http://localhost:8000/jsonp/<methode>?callback=<callback>

Die aufgerufene Methode wird im Pfad der Interface-URI übergeben.

Der Name für die Callback-Methode wird als Parameter Callback übergeben.

Parameter können via HTTP per GET im Format application/x-www-form-urlencoded übergeben werden.

Die Ausgabe erfolgt als Javascript-Funktionsaufruf mit einem JSON-Objekt als Parameter.

Methoden

${method.title}

${method.name}${method.func_line}

Diese Methode at bis jetzt noch keine Beschreibung.

Parameter
Parameter Typ Beschreibung
${arg.name} ${arg.typ} ${arg.description}
Ausgabe
Parameter Typ Beschreibung
${arg.name} ${arg.typ} ${arg.description}