WIMONDO:: Mit L4Net-Webservice-L4(SOAP) erhalten Sie die Freiheit die Funktionalität der L4Net-Dienste in eigene Projekte (Hotelsoftware oder Payment-Gateways für z.B. Kreditkartenzahlung oder PayPal ...) zu integrieren.

Mit 'L4Net::Webservice-L4(SOAP)' erhalten Sie die Freiheit die Funktionalität der L4Net-Dienste in eigene Projekte (Hotelsoftware, Payment-Gateways für z.B. Kreditkartenzahlung oder PayPal, ...) zu integrieren.

Einführung

Webservices sind eine moderne und populäre Technologie. SOAP(Simple Object Access Protocol) als deren wichtigster Vertreter ist ein XML-basiertes Protokoll zum Austausch strukturierter Informationen zwischen verteilten Applikationen über native Webprotokolle wie z.B. HTTP. SOAP spezifiziert das Format welches XML-Messages benutzen, die Art in welcher diese verarbeitet werden sollen, Codierungsregeln für Datentypen und Konventionen zur Repräsentation von 'Remote Procedure Calls(RPC)' und Responses. Entsprechende Implementierungen stehen in allen gängigen Programmiersprachen zur Verfügung.

Das folgende Beispiel (in PHP-5.1) verdeutlicht die einfache Nutzung:

Schritt 1 - Erzeugen eines SoapClients:
$client = new SoapClient("http://www.wimondo.com/webservice/L4WebService.wsdl", array("login"=>"myname", "password"=>"mypassword");
Schritt 2 - Aufruf einer Funktion:
$account = $client->createAccount("U99999999:timewindow:1d");
Schritt 3 - Weiterverarbeitung:
echo $account->code;

Funktionsbeschreibung:

Name: getAccount
Parameter: Code(S)
Rückgabe: AccountObjekt
Fehlercodes: 01
Beispiel(PHP-5.1): $account = $client->getAccount("av0fghj7tyxc"); echo $account->acc_fulltime;

Name: createAccount
Parameter: UID(S): Typ[time|timewindow](S):
Zeit[15m,1h,2h,5h,10h,24h,50h|1d,1w,2w,1m,6m,1y](S)
Rückgabe: AccountObjekt
Fehlercodes: 02,03,04
Beispiel(PHP-5.1): $account = $client->createAccount("U99999999:timewindow:1d");
echo $account->code;

Name: getAccounts
Parameter: Code(S)
Rückgabe: AccountsObjekt
Fehlercodes: 02
Beispiel(PHP-5.1): $accounts = $client->getAccounts("U99999999");
foreach ($accounts->Accounts as $account) {
echo $account->code.":".$account->online_status."\n";
}

Name: actionAccount
Parameter: Code(S):Aktion[lock,unlock,disconnect,delete](S)
Rückgabe: AccountObjekt
Fehlercodes: 01,05
Beispiel(PHP-5.1): $account = $client->actionAccount("av0fghj7tyxc:delete");

Name: getGateways
Parameter: -
Rückgabe: GatewaysObjekt
Fehlercodes:
Beispiel(PHP-5.1): $gateways = $client->getGateways();
foreach ($gateways->Gateways as $gateway) {
echo $gateway->uid.":".$gateway->name."\n";
}

Name: getGatewayIsOnline
Parameter: UID(S)
Rückgabe: Boolean TRUE/FALSE
Fehlercodes: 02
Beispiel(PHP-5.1): $online= $client->getGatewayIsOnline("U99999999");
if($online) echo "online"; else echo "offline";

Name: getConnections
Parameter: Code(S)
Rückgabe: ConnectionsObjekt
Fehlercodes: 01
Beispiel(PHP-5.1): $connections = $client->getConnections("av0fghj7tyxc");
foreach ($connections->Connections as $connection) {
echo $connection->start.":".$connection->stop."\n";
}

Name: getTransactionsCount
Beschreibung: Liefert die Anzahl der über die Webserviceschnittstelle durchgeführten Transaktionen im angegebenen Berichtszeitraum zurück.
Parameter: Periode(S)[today,yesterday,thisweek,lastweek,thismonth,lastmonth]
Rückgabe: Transaktionen in der Periode(I)
Fehlercodes: 06
Beispiel(PHP-5.1): $count = $client->getTransactionsCount("thismonth");
echo "Transactions: $count";

Typen:
AccountObjekt
[code](S) Code
[online_status](I) Onlinestatus: 0=Offline, 1=Online, 3=Pending to disconnect
[acc_attr](S) Attribut
[acc_mode](S) Accounttyp: time | timewindow
[acc_ctime](I) Erzeugungszeitstempel (Unix-Timestamp)
[acc_atime](I) Aktivierungszeitstempel (Unix-Timestamp)
[acc_ltime](I) Zeitstempel des letzten Zugriffs (Unix-Timestamp)
[acc_rtime](I) Verbleibendes Zeitkontingent des Accounts in Sekunden
[acc_fulltime](I) Volles Zeitkontingent des Accounts in Sekunden

GatewayObjekt
[uid](S) UID des Hotspot-L4
[name](S) Name des Hotspot-L4

ConnectionObjekt
[token](S) Verwendetes Verbindungstoken
[token_status](I) Status der Verbindung: 0=Unused, 1=In use, 2=Used, 3=Pending to disconnect
[start](I) Start der Verbindung (Unix-Timestamp)
[stop](I) Ende der Verbindung (Unix-Timestamp)
[incoming](I) Eingehende Bytes der Verbindung
[outgoing](I) Ausgehende Bytes der Verbindung
[ip_user](S) Über DHCP intern zugewiesene IP des Nutzers
[ip_gateway](S) IP des Gateways(Hotspot)
[mac](S) MAC-Adresse des Benutzers
[lang](S) Gewählte Sprache des Nutzers
[last_updated](I) Letzte Verbindungsaktualisierung (Unix-Timestamp)

Fehlercodes(faultcode:faultstring):
01:No such account
02:No such gateway
03:No such type
04:No such time
05:No such action
06:No such period

Beispiel(PHP-5.1) mit Fehlerbehandlung:
try { $account = $client->createAccount("U99999999:timewindow:1d"); echo $account->code; } catch (SoapFault $soapFault) { echo $soapFault->faultcode.":".$soapFault->faultstring; }

Systemvoraussetzung: HTTPS-fähige SOAP-Softwareschnittstelle

Sicherheit: Die Datenübertragung mit dem Webservice wird durch eine sichere Verbindung geschützt (SSL mit 256bit Verschlüsselung).

Referenzen:
“Simple Object Access Protocol (SOAP) 1.1” (http://www.w3.org/TR/2000/NOTE-SOAP-20000508/)
“SOAP 1.2 Part 0: Primer” (http://www.w3.org/TR/2003/REC-soap12-part0-20030624/)
“SOAP 1.2 Part 1: Messaging Framework" (http://www.w3.org/TR/2003/REC-soap12-part1-20030624/)
"SOAP 1.2 Part 2: Adjuncts" (http://www.w3.org/TR/2003/REC-soap12-part2-20030624)
“Web Services Description Language (WSDL) 1.1” (http://www.w3.org/TR/2001/NOTE-wsdl-20010315)
"XML Schema Part 1: Structures" (http://www.w3.org/TR/2001/REC-xmlschema-1-20010502/)
"XML Schema Part 2: Datatypes" (http://www.w3.org/TR/2001/REC-xmlschema-2-20010502/)