Per SOAP Webservice können etwaige gespeicherte Daten abgerufen bzw. gespeicherte Daten manipuliert werden. Für viele Programmiersprachen sind vorgefertigte SOAP-Bibliotheken verfügbar. Die Grundlage für SOAP ist eine WSDL-Datei, welche alle Funktionen der API beschreibt.
Siehe dazu auch:
API mit JavaScript Object Notation (JSON) nutzen
Voraussetzung für den Einsatz der API
Die API kann nur mit PHP 5 oder neuer verwendet werden, PHP 4 wird nicht
unterstützt.
Aufruf des SOAP Webservices
Den SOAP Webservice rufen Sie über http://<ihre
_domain>/<installations_verzeichnis>/api/api.php im Browser bzw. im
eigenen Script mit Hilfe des SOAP Clients auf. Im Browser werden als
HTML-Variante alle verfügbaren Funktionen und notwendigen Parameter der API
dargestellt. Beachten Sie zu den einzelnen Funktionen unbedingt die
Dokumentation zur jeweiligen Funktion.
Authentifizierung beim SOAP Webservice
Für die Authentifizierung wird ein API Key benötigt, diesen finden Sie
unter Menü Benutzer - Eigenes Konto ändern.
Hinweis: Nur die Nutzertypen SuperAdmin und Admin verfügen über einen
API Key, normale Nutzer dürfen nicht per API zugreifen.
Die Authentifizierung erfolgt über einen SOAP Header, der Name des Header lautet APIToken. Nur durch korrekte Übergabe des API Key bei jedem Aufruf wird ein Zugriff auf die gespeicherten Daten erlaubt.
Der API Key selbst erlaubt nur den Zugriff auf die Daten des SuperAdmin oder Admins selbst, nicht auf andere Admin-Nutzer.
Zeichen-Codierung der Daten
Alle Daten werden UTF-8 codiert zurückgegeben bzw. müssen mit der
Codierung UTF-8 übergeben werden, ansonsten kann es zu Fehlern kommen bzw.
Umlaute/Sonderzeichen werden nicht korrekt gespeichert.
Datentypen
Folgende Datentypen werden verwendet:
| XML Schema Datentyp | Datentyp in PHP und anderen Programmiersprachen |
| xsd:string | string |
| xsd:int | integer |
| xsd:float | float |
| xsd:boolean | boolean |
| xsd:double | double |
| xsd:Array | array |
| xsd:datetime | datetime |
Definierte Klassen
| Klassenname | Beschreibung |
| api_Common | Enthält grundlegende Funktionen, die teilweise nur als Nutzer SuperAdmin aufgerufen werden können. |
| api_Mailinglists | Enthält Funktionen zur Manipulation von Empfängerlisten. |
| api_Recipients | Funktionen zur Manipulation der Empfänger in den Empfängerlisten. |
| api_Users | Enthält Funktionen zum Anlegen und Entfernen von Nutzern. |
| api_DistributionLists | Enthält Funktionen für die Verteilerlisten.
Nur nutzbar mit SuperMailingList Professional, SuperWebMailer Professional und SuperWebMailer Enterprise.
|
| Nur SuperWebMailer | |
| api_Campaigns | Enthält Funktionen für das Erstellen, Ändern und Abrufen
von Statistiken für E-Mailings.
|
| api_FUResponders | Enthält Funktionen für das Erstellen, Ändern und Abrufen
von Statistiken für Folow-Up-Auto-Responder.
Nicht in SuperWebMailer Basic nutzbar.
|
Beispiel für den Aufruf des Webservice
Im api-Verzeichnis finden Sie die Datei nusoap_sample.php diese verwendet die nusoap-Bibliothek, welche ebenfalls zur Realisierung des SOAP-Servers verwendet wird.
Einfaches Beispiel in PHP zur Bestimmung der API Version
<?php
require_once("nusoap/lib/nusoap.php");
# url to api.php
$api = 'http://<ihre _domain>/<installations_verzeichnis>/api/api.php';
# set your api key here
$apikey = 'api key here';
$client = new nusoap_client($api);
$client->soap_defencoding = 'UTF-8'; # use UTF-8!
$err = $client->getError();
if ($err) {
echo '<h2>Constructor error</h2><pre>' . $err . '</pre>';
}
# set APIToken
$client->setHeaders(array('APIToken' => $apikey));
# get API version
$params = array(); # no params
$result = $client->call('api_Common.api_getAPIVersion', $params, '', '', false, true);
if($client->fault)
print_r($result);
else
if($client->getError())
print $client->getError();
else
var_dump($result);
?>
Siehe dazu auch:
API mit JavaScript Object Notation (JSON) nutzen