Konfiguration
Zum Inhaltsverzeichnis zurückkehren
Die Ansteuerungs-Klasse
Zur Ansteuerung der Schnittstelle stellen wir Ihnen für die Programmiersprache PHP eine einzige Klasse bereit, mit dieser Sie die Funktionen ansteuern können und auch zwischen dem XML-RCP-Protokoll und der gewöhnlichen HTTPS-Schnittstelle umherschalten können.
Kopieren Sie diese Klasse in Ihr Software-Verzeichnis und binden Sie sie per include()-Funktion ein.
Zugangsdaten für die Schnittstelle
Wenn Sie sich zur Schnittstelle verbinden möchten, müssen Sie die Benutzerkennung des Kundenaccounts und ggf. eine Partner-ID angeben. Das Passwort gleicht nicht dem des Kundenbereiches, sondern wird im Kundenbereich unter Einstellungen separat vergeben.
Grundlegender Aufbau eines Befehles
Der Aufbau eines Funktionsaufrufes besteht im Wesentlichen nur in der Angabe der Zugangsdaten, der Angabe der Funktion, die aufgerufen werden soll und abschließend werden die Parameter der jeweiligen Funktion angegeben.
<?php
/**
*
* @package Example
*
*/
include('./classes/request.class.php');
/**
Zugangsdaten des adorius-Kunden
Das Passwort für die Schnittstelle unterscheidet sich
aus Sicherheitsgründen vom Passwort des Kundenbereichs.
Wenn Sie über keine Partner-ID verfügen, lassen Sie den
Wert bitte auf NULL gestellt.
*/
$username = 'Benutzername';
$password = 'Passwort';
$partnerID = NULL;
/**
Befehl, der ausgeführt werden soll
*/
$method = 'functionName';
/**
Parameter
*/
$params['param1'] = 'Parameter 1';
$params['param2'] = 'Zweiter Parameter';
$params['param3'] = 'Dritter Parameter';
/**
Vorbereiten
*/
$request = new request($username, $password, $partnerID);
/**
Befehl ausführen
*/
$result = $request->call($method, $params);
/**
Rückgabewert leserlich ausgeben
*/
print('<pre>');
print_r($result);
print('</pre>');
?>Als Rückgabe erhalten Sie ein Array. Dabei wird immer ein Statuscode zurückgegeben. Der Statuscode 100 entspricht einem fehlerfreien Funktionsaufruf, alle anderen Statuscodes sind spezifisch. Zusätzlich zum Statuscode erhalten Sie eine Beschreibung.
Array
(
[adoCode] => 100
[adoMsg] => Der Brief wurde erfolgreich in den Versand gegeben.
)Die Beschreibung können und sollten Sie weiterverwenden. Eine Prüfung der eingelieferten Daten wird von der Schnittstelle automatisiert vorgenommen, daher kann Ihre Software Rückmeldungen direkt an den Benutzer weitergeben.
Durchführung eines Tests
Bitte führen Sie zunächst einen Funktionstest durch. Dazu existiert die Funktion serviceTrial mit der Sie die ordnungsgemäße Kommunikation testen können. Geben Sie bei den Parametern auch Umlaute ein.
Um den Test durchzuführen, benutzen Sie bitte den oben beschriebenen Grundaufbau eines Funktionsaufrufes. Die Variable $methodName besetzen Sie bitte mit dem Funktionsnamen, in diesem Falle also serviceTrial.
Das nachfolgende Beispiel zeigt einen Testaufruf, bei dem auch Umlaute eingegeben wurden, um eine korrekte Übertragung zu bestätigen (die Eingaben werden bei der Testfunktion zurückgeliefert).
<?php
include('./classes/request.class.php');
$username = 'Benutzername';
$password = 'Passwort';
$method = 'serviceTrial';
$params['Vorname'] = 'Marc-Ándre';
$params['Nachname'] = 'Fleiß';
$request = new request($username, $password, NULL);
$result = $request->call($method, $params);
print('<pre>');
print_r($result);
print('</pre>');
?>Wenn der Aufruf korrekt war, erhalten Sie einen Statuscode 100 sowie die übermittelten Daten an die Schnittstelle korrekt codiert zurück.