Mit dem Webservice-API des Online Marketing Cockpits können Sie aus Anwendungen heraus auf das OMC per HTTP(S) zugreifen, um Daten auszulesen, zu ändern oder anzulegen.
Ressourcen wie Account-, Personen-, Anfrage- oder Mailing-Details können zu Testzwecken auch mit einem Browser abgefragt werden. Verwenden Sie hierfür eine URL nach dem folgenden Muster:
http://user_name:api_key@host_name:port/webservice/entity_name/id/
Der Zugriff auf das OMC ist mittels Basic Authentication geschützt. Verwenden Sie als Benutzernamen webservice und als Passwort einen der API-Keys, die Sie in der Allgemeinen Konfiguration eingetragen haben.
Die Variablen in der obigen URL haben die folgende Bedeutung:
| Variable | Bedeutung |
|---|---|
user_name |
Benutzername. Er lautet immer webservice. |
api_key |
Einer der API-Keys, die in der Konfiguration eingetragen wurden. |
host_name |
Der Name des Hosts, unter dem das OMC erreichbar ist. |
port |
Der Port auf dem Host, auf dem das OMC erreichbar ist (voreingestellt 3000) |
entity_name |
Eine der folgenden Zeichenketten:accounts,
contacts,
inquiries,
mailings,
events,
sessions |
id |
Die ID der relevanten Entität der betreffenden Kategorie. |
Das folgende Beispiel ermittelt den Datensatz der Person mit der angegebenen ID. Der API-Key wurde aus Gründen der Lesbarkeit gekürzt; er muss mindestens 32 Zeichen lang sein.
http://webservice:APIKey@host.domain:3000/webservice/contacts/4352
Das Ergebnis formal gültiger Requests sind standardkonforme HTTP-Responses, deren Status-Codes 200 und 404 über den erfolgreichen bzw. fehlgeschlagenen Zugriff auf eine Ressource Auskunft geben. Der Webservice gibt Daten und gegebenenfalls Fehlermeldungen in Form eines XML-Dokuments im Body der Responses zurück. Die Syntax gültiger Anfragen sowie Beispiele für Ergebnisdokumente finden Sie in den folgenden Abschnitten.
Die Beispiele haben die Form von curl-Aufrufen. curl ist ein Tool, mit dem Requests über die Kommandozeile abgesetzt und die Responses betrachtet werden können.