Verwendung des mailworx SOAP Webservice

Die mailworx Schnittstelle ist mittels eines SOAP Webservice realisiert, der unter der URL https://sys.mailworx.info/Services/ServiceAgent.asmx erreichbar ist.

Die Schnittstellendefinition finden Sie unter https://sys.mailworx.info/Services/ServiceAgent.asmx?WSDL.

Verfügbare Methoden des SOAP Webservice

Die mailworx Webservice Schnittstelle umfasst folgende Methoden:

Methode Beschreibung
ExportSubscribers Ermöglicht das Auslesen der vorhandenen mailworx Abonnenten.
GetCampaigns Ermöglicht das Auslesen der vorhandenen Kampagnen in mailworx.
GetLanguages Ermöglicht das Auslesen der, für einen Kunden verfügbaren Sprachen.
GetProfiles Ermöglicht das Auslesen der vorhandenen Abonnentengruppen in mailworx.
GetSubscriberFields

Ermöglicht das Auslesen der vorhandenen Abonnentenfelder in mailworx (z.B.: Vorname, Nachname, E-Mail, Geburtsdatum, …)

ImportSubscribers Ermöglicht das Importieren von Abonnenten in mailworx.
DeleteSubscribers Ermöglicht das Löschen von Abonnenten.
UpdateSubscriberFields Ermöglicht die Wartung der Abonnentenfelder in mailworx (Hinzufügen/Bearbeiten von Abonnentenfelder und Auswahlmöglichkeiten).
CreateProfile Ermöglicht das Erstellen einer neuen statischen Abonnentengruppe.
UpdateProfile Ermöglicht die Wartung einer vorhandenen Abonnentengruppe.
DeleteProfile Ermöglicht das Löschen einer vorhandenen Abonnentengruppe.
CombineProfile Ermöglicht das Kombinieren von vorhandenen Abonnentengruppen.
RemoveSubscribersFromProfile Ermöglicht das Löschen spezifischer Abonnenten aus einer Abonnentengruppe.
CopyCampaign Ermöglicht das Kopieren einer vorhandenen „kopierbaren“ Kampagne („Kopieren zulassen“ muss gesetzt sein).
GetCopyableCampaign Ermöglicht das Auslesen von "kopierbaren" Kampagnen.
UpdateCampaign Ermöglicht die Wartung von vorhandenen Kampagnen.
GetCampaign Ermöglicht das Auslesen von Kampagneninformationen.
CreateCampaign Ermöglicht das Erstellen einer Kampagne.
SendCampaign Ermöglicht das Versenden einer bestehenden Kampagne.
SendTriggerMails Ermöglicht das Versenden von ereignisabhängigen Kampagnen (Trigger-Mails) mit maßgeschneiderten Inhalten.
AreCampaignsInWork Ermöglicht das Abfragen, ob die vorhandenen Kampagnen noch in Arbeit sind.
SendCampaignToSubscriber Ermöglicht das Nachaussenden einer Kampagne an einzelne Abonnenten.
GetTemplates Ermöglicht das Auslesen der verfügbaren Newsletter Vorlagen.
CampaignStatistics Ermöglicht das Abrufen der Kampagnenstatistik-Übersicht.
GetMailClientTypesOfCampaign Ermöglicht das Auslesen von Mailclient Typen.
GetAccounts Ermöglicht das Auslesen der verfügaberen Mandanten.
GetUsers Ermöglicht das Auslesen aller Benutzer des aktuellen Mandanten.
GetUsersInformation Ermöglicht das Auslesen von Informationen über den aktuellen Benutzer.
ImportRobinsonlist Ermöglicht das Importieren der Robinsonliste.
GetBouncesOfCampaign Ermöglicht das Abfragen von Rückläufern einer Kampagne.
GetClickRatesOfCampaign Ermöglicht das Abfragen von Klickraten einer Kampagne.
GetLinkClicksOfCampaign Ermöglicht das Abfragen der Abonnenten, welche einen bestimmten Link einer Kampagne geklickt haben
GetOpeningRatesOfCampaign Ermöglicht das Abfragen der Öffnungsrate einer Kampagne
CreateFieldMapping Ermöglicht das Erstellen von Feldzuordnungen, verwendet für die Integration externer Anwendungen.
DeleteFieldMapping Ermöglicht das Löschen von Feldzuordnungen, die von externen Anwendungen erstellt wurden.
GetSectionDefinitions Ermöglicht das Abfragen von Abschnitten einer Newslettervorlage.
CreateSection Ermöglicht das Erstellen eines neuen Abschnittes in einer Kampagne.
UpdateSection Ermöglicht das Ändern eines Abschnittes einer Kampagne.
DeleteSection Ermöglicht das Löschen eines Abschnittes einer Kampagne.
GetImagesOfCampaign Ermöglicht das Auslesen von Bildern in einer Kampagne.
CreateSMSCampaign Ermöglicht das Erstellen einer neuen SMS Kampagne.
GetSendActionInProgress Ermöglicht das Abfragen des Versandstatus einer Kampagne.
CreateCentralSection Ermöglicht das Erstellen eines neuen zentralen Inhaltes.
UpdateCentralSection Ermöglicht das Ändern eines zentralen Inhaltes.
DeleteCentralSection Ermöglicht das Löschen eines zentralen Inhaltes.
GetEvents Ermöglicht das Auslesen von Veranstaltungsinformationen.
GreateEvent Ermöglicht das Erstellen einer Veranstaltung.
UpdateEvent Ermöglicht das Ändern einer Veranstaltung.
CopyEvent Ermöglicht das Kopieren einer Veranstaltung.
DeleteEvent Ermöglicht das Löschen einer Veranstaltung.
GetEventGuestList Ermöglicht das Auslesen von Gästen einer Veranstaltung.

 

Die Synchronisation von Abonnenten via SOAP Webservice wird mit der Kombination der MethodenExportSubscribers und ImportSubscribers unter Verwendung von GetSubscriberFields implementiert.

Aufruf-Konzept des SOAP Webservice

Das Konzept der mailworx SOAP Webservice Schnittstelle ist nachrichtenbasiert. Sämtliche Methoden des SOAP Webservice erwarten genau einen Übergabeparameter (RequestMessage) und geben genau einen Rückgabewert (ResponseMessage) zurück. Die RequestMessage beinhaltet alle Informationen, die zur Ausführung der Methode des SOAP Webservice notwendig ist. Die ResponseMessage liefert nach erfolgreicher Ausführung der Methode entsprechende methodenspezifische Daten über den SAOP Webservice.

Die mailworx SOAP Webservice Schnittstelle verwaltet bei der Verwendung keinen Status. Es ist daher erforderlich, dass die Login Daten bei jedem Methodenaufruf via SOAP Webservice mitgegeben werden. Die Login Daten für mailworx werden unverschlüsselt angegeben. Aus diesem Grund empfiehlt es sich die SOAP Webservice Schnittstelle ausschließlich über HTTPS aufzurufen. Die Login Daten werden bei einer Nachricht in der Eigenschaft SecurityContext gesetzt.

Dieser SecurityContext beinhaltet vier Eigenschaften: AccountUsernamePasswordSource. Die Eigenschaft Source vom SecurityContext ist der Name der Anwendung, die die SOAP Webservice Schnittstelle aufruft. Die Anwendung bzw. der hier angeführte Name muss von eworx Network & Internet GmbH zur Verwendung der SOAP Webservice Schnittstelle freigegeben werden. Weiters wird von eworx Network & Internet GmbH festgelegt, welche Methoden der mailworx SOAP Webservice Schnittstelle für diese Anwendung zur Verfügung stehen. Gemäß dem Fall, dass eine Methode des SOAP Webservice von einer Anwendung aufgerufen wird, die jedoch nicht für diese Anwendung freigegeben ist, wird eine Ausnahme geworfen und die Ausführung dieser Methode verhindert.

Da mailworx verschieden sprachige Newsletter verwalten kann, erfordert jede RequestMessage eine Eigenschaft "Language", die mit dem entsprechenden Sprachkürzel zu verwenden ist (z.B. de, en …).

Durch diese Ausführung ergibt sich, dass jede RequestMessage mindestens zwei Eigenschaften besitzt: Language und den SecurityContext mit den Login Daten zu mailworx. Dies ist dadurch sichergestellt, dass jede RequestMessage in mailworx von SecureRequestMessageableitet.

Um das System zu entlasten und die höchstmögliche Zuverlässigkeit zu gewährleisten, ist das Request Limit auf 300 Aufrufe pro Minute beschränkt.

Absichern der SOAP Webservice Schnittstelle

Der SOAP Webservice kann per SOAP over HTTP oder SOAP over HTTPs verwendet werden. Durch die Verwendung von HTTPs wird die Kommunikation zwischen Client und Server verschlüsselt und die Datenübertragung via SOAP Webservice abgesichert.

Zahlreiche Konzepte wurden zum Schutz Ihrer Daten, sowie für die Sicherheit und Stabilität des mailworx® Systems ausgearbeitet und umgesetzt.

Die mailworx® Plattform wird in einem zentralen Rechenzentrum in Linz betrieben und ist direkt an den hochverfügbaren Internetbackbone angebunden. Modernste Firewall-Technologien und konstantes Monitoring garantieren bestmöglichen Schutz.