Die mailworx SOAP Schnittstelle erlaubt eine nahtlose Integration in Ihre Produkte. Egal, ob eine Vollintegration oder die Synchronisation von Kontaktdaten erforderlich ist, die standardisierte mailworx Schnittstelle erfüllt Ihre Anforderungen. Die Schnittstelle ist als SOAP Web-Service verfügbar und erlaubt einen verschlüsselten Zugriff per 1024 RSA Public Key SSL Zugang. Da es sich um eine SOAP Schnittstelle handelt, ist diese unabhängig von der Technologie und kann sowohl von JAVA, PHP, .NET als auch Phyton und anderen Programmiersprachen aufgerufen werden.
SOAP ist ein weit verbreiteter Standard und benutzt HTTP bzw. HTTPS als Übertragungsprotokoll. Dadurch ist keine spezielle Firewall Konfiguration notwendig.
Beschreibung der API Schnittstelle
Diese Seite beschreibt detailliert den Aufbau der mailworx Schnittstelle und im Überblick die verfügbaren Methoden:
Abonnenten
Abonnenten sind in Abonnentengruppen zusammengefasst. Diese Methode ermöglicht das Auslesen der bestehenden Abonnentengruppen über die Schnittstelle.
Erstellen Sie eine neue statische Abonnentengruppe mit dieser Methode um zum Beispiel Abonnenten für einen späteren Versand zu gruppieren.
Aktualisieren Sie Abonnentengruppen mit dieser Methode.
Mit dieser Methode werden Abonnentengruppen, die nicht mehr benötigt werden wieder gelöscht.
Einzelne Abonnentengruppen werden zu einer neuen statischen Abonnentengruppe zusammengeführt.
Mit dieser Methode werden Abonnenten aus einer statischen Abonnentengruppe entfernt.
Diese Methode gibt Aufschluss darüber, welche Daten – z.B.: Vorname, Nachname, E-Mail, Geburtsdatum etc. – für Abonnenten gespeichert werden. Diese Information ist für den Abonnentenimport und Abonnentenexport wichtig.
Die Kontaktsynchronisation wird mit der Kombination von Export und Import durchgeführt.
Die Kontaktsynchronisation wird mit der Kombination von Export und Import durchgeführt.
Nicht mehr benötigte und lediglich temporär importierte Abonnenten können natürlich wieder gelöscht werden. Mit dieser Methode werden automatische Datenbereinigungsprozesse implementiert.
Abonnentenfelder beschreiben welche Daten in mailworx für jeden Abonnenten abgelegt werden. Diese Methode ermöglicht das Bearbeiten dieser Felder.
Feldzuordnung beschreiben ein Matching von Abonnentenfeldern verschiedener Anwendungen. Dadurch kann mailworx kennzeichnen welche Daten von Ihrer Anwendung mit mailworx synchronisiert werden und welche nicht. Diese Information wird dem Benutzer visuell dargestellt.
Feldzuordnung beschreiben ein Matching von Abonnentenfeldern verschiedener Anwendungen. Dadurch kann mailworx kennzeichnen welche Daten von Ihrer Anwendung mit mailworx synchronisiert werden und welche nicht. Diese Information wird dem Benutzer visuell dargestellt.
Kampagnen
Liefert die für den aktuellen Mandanten verfügbaren Sprachen.
Liest alle verfügbaren E-Mail-Kampagnen aus.
Nicht jede Kampagne ist dazu gedacht kopiert zu werden. In mailworx kann konfiguriert werden, welche Kampagnen zum Kopieren verfügbar sind. Diese Methode liefert diese Information.
Erstellen Sie eine neue Kampagne auf Basis einer bereits bestehenden Kampagne.
Aktualisieren Sie diverse Informationen einer Kampagne mit dieser Methode.
Erstellen Sie mit dieser Methode eine neue E-Mail Kampagne.
Kampagnen unterliegen einem Workflow Status. Diese Methode liefert alle E-Mail Kampagnen, welche sich in Arbeit befinden.
E-Mail-Kampagnen können mit Hilfe dieser Methode an einzelne Abonnenten geschickt werden - Benachrichtigungen oder Geburtstagsmails werden damit beispielsweise abgebildet.
Fügen Sie mit Hilfe dieser Methode einer bestehenden Kampagne einen neuen Abschnitt hinzu.
Verwenden Sie diese Methode, um die Informationen eines Abschnittes zu aktualisieren.
Mit Hilfe dieser Methode können Sie einen bestehenden Abschnitt einer Kampagne löschen.
Newslettervorlagen
Um Kampagnen erstellen zu können ist es erforderlich, die vorhandenen Newslettervorlagen zu kennen. Mit dieser Methode werden die verfügbaren Vorlagen ausgelesen.
Zum Erstellen von zentralen Inhalten oder eines Abschnittes einer Kampagne wird die Definition des Abschnittes aus der Newslettervorlage benötigt. Vorhandene Abschnitte einer Newslettervorlage können mit dieser Methode ausgelesen werden.
Zentrale Inhalte
Mit dieser Methode können alle zentralen Inhalte einer bestimmten Newslettervorlage ausgelesen werden.
Erstellen Sie mit dieser Methode einen neuen zentralen Inhalt.
Aktualisieren Sie die im zentralen Inhalt enthaltenen Informationen.
Benutzen Sie diese Methode um einen zentralen Inhalt zu löschen.
Statistik
Auslesen von Kampagnenstatistik-Informationen wie Rückläufer, Klicks oder auch Öffnungen.
Mandanten
Mit dieser Methode können alle Mandanten auf die der aktuelle Benutzer Zugriff hat ausgelesen werden.
Sperrlisten
Importieren Sie Robinsonlisten über einen oder mehrere Mandanten hinweg.