Eine Schnittstelle zur perfekten Integration

Die API zu Ihrer Software

Mit der mailworx Schnittstelle können Sie die professionelle Newsletter Software nahtlos in Ihre Wunschsoftware integrieren. Die API steht Ihnen sowohl als SOAP, als auch als JSON Web-Service zur Verfügung - ist also unabhängig von der Technologie und kann von JAVA, PHP, .NET, Python und anderen Programmiersprachen abgerufen werden.

Um die API verwenden zu können, müssen Sie sich zuerst Ihre persönliche Schnittstelle konfigurieren.

Wunschsystem erstellen

Und so verwenden Sie die mailworx API - hier finden Sie die Beschreibung:

Die Verwendung der SOAP Schnittstelle (Web-Service)

Diese Seite beschreibt detailliert den Aufbau der mailworx Schnittstelle und im Überblick die verfügbaren Methoden.

mehr erfahren

Die Verwendung der JSON Schnittstelle (Web-Service)

Diese Seite beschreibt detailliert den Aufbau der mailworx Schnittstelle.

mehr erfahren

Abonnenten

Abonnentengruppen mit der API Schnittstelle auslesen – GetProfiles

Abonnenten sind in Abonnentengruppen zusammengefasst. Diese Methode ermöglicht das Auslesen der bestehenden Abonnentengruppen über die Schnittstelle.

mehr erfahren

Neue Abonnentengruppen über die API Schnittstelle erstellen - CreateProfile

Erstellen Sie eine neue statische Abonnentengruppe mit dieser Methode um zum Beispiel Abonnenten für einen späteren Versand zu gruppieren.

mehr erfahren

Abonnentengruppen über die API Schnittstelle ändern – UpdateProfile

Aktualisieren Sie Abonnentengruppen mit dieser Methode.

mehr erfahren

Eine Abonnentengruppe über die API Schnittstelle löschen – DeleteProfile

Mit dieser Methode werden Abonnentengruppen, die nicht mehr benötigt werden wieder gelöscht.

mehr erfahren

Kombinieren von Abonnentengruppen über die API Schnittstelle - CombineProfile

Einzelne Abonnentengruppen werden zu einer neuen statischen Abonnentengruppe zusammengeführt.

mehr erfahren

Abonnenten aus einer Abonnentengruppe entfernen - RemoveSubscribersFromProfile

Mit dieser Methode werden Abonnenten aus einer statischen Abonnentengruppe entfernt.

mehr erfahren

Auslesen von Abonnentenfeldern - GetSubscriberFields

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.

mehr erfahren

Exportieren von Abonnenten über die API Schnittstelle – ExportSubscribers

Die Kontaktsynchronisation wird mit der Kombination von Export und Import durchgeführt.

mehr erfahren

Exportieren von Abonnenten via SAP über die API Schnittstelle – SAPExportSubscribers

Die Kontaktsynchronisation wird mit der Kombination von Export und Import auch via SAP durchgeführt.

mehr erfahren

Abonnenten importieren – ImportSubscribers

Die Kontaktsynchronisation wird mit der Kombination von Export und Import durchgeführt.

mehr erfahren

Abonnenten via SAP importieren – SAPImportSubscribers

Die Kontaktsynchronisation wird mit der Kombination von Export und Import auch via SAP durchgeführt.

mehr erfahren

Löschen von Abonnenten - DeleteSubscribers

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.

mehr erfahren

Wartung der Abonnentenfelder über die API Schnittstelle - UpdateSubscriberFields

Abonnentenfelder beschreiben welche Daten in mailworx für jeden Abonnenten abgelegt werden. Diese Methode ermöglicht das Bearbeiten dieser Felder.

mehr erfahren

Erstellen von Feldzuordnungen über die API Schnittstelle - CreateFieldMapping

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.

mehr erfahren

Löschen von Feldzuordnungen über die API Schnittstelle - DeleteFieldMapping

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.

mehr erfahren

Massenänderung von Abonnentendaten über die API Schnittstelle - MultipleSubscriberChange

Suchen und ersetzen Sie Daten aller oder bestimmten Abonnenten.

mehr erfahren

Kampagnen

Auslesen der verfügbaren Sprachen über die API Schnittstelle - GetLanguages

Liefert die für den aktuellen Mandanten verfügbaren Sprachen.

mehr erfahren

Auslesen von Kampagneninformationen – GetCampaigns

Liest alle verfügbaren E-Mail-Kampagnen aus.

mehr erfahren

Auslesen von kopierbaren Kampagnen über die API Schnittstelle – GetCopyableCampaigns

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.

mehr erfahren

Kopieren einer bestehenden Kampagne – CopyCampaign

Erstellen Sie eine neue Kampagne auf Basis einer bereits bestehenden Kampagne.

mehr erfahren

Ändern einer Kampagne über die API Schnittstelle – UpdateCampaign

Aktualisieren Sie diverse Informationen einer Kampagne mit dieser Methode.

mehr erfahren

Erstellen einer Kampagne über die API Schnittstelle – CreateCampaign

Erstellen Sie mit dieser Methode eine neue E-Mail Kampagne.

mehr erfahren

Versenden einer Kampagne - SendCampaign

Versenden Sie eine bestehende mailworx Kampagne. Folgende Versandarten werden unterstützt: manuell, zeitgesteuert & A/B Split Test.

mehr erfahren

Generieren von individualisierten Trigger-Mails – GENERATETRIGGERMAIL

Generieren Sie individuelle Trigger-Mails vorab, um sich die finalen E-Mails anzusehen, bevor Sie diese über SendTriggerMails tatsächlich versenden.

mehr erfahren

Versenden von individualisierten Trigger-Mails - SendTriggerMails

Versenden Sie zu bestimmten Anlässen maßgeschneiderte Inhalte an Ihre Empfänger.

mehr erfahren

Sind bestehende Kampagnen noch in Bearbeitung? – AreCampaignsInWork

Kampagnen unterliegen einem Workflow Status. Diese Methode liefert alle E-Mail Kampagnen, welche sich in Arbeit befinden.

mehr erfahren

Nachaussenden einer Kampagne – SendCampaignToSubscriber

E-Mail-Kampagnen können mit Hilfe dieser Methode an einzelne Abonnenten geschickt werden - Benachrichtigungen oder Geburtstagsmails werden damit beispielsweise abgebildet.

mehr erfahren

Erstellen eines Abschnittes einer Kampagne über die API Schnittstelle - CreateSection

Fügen Sie mit Hilfe dieser Methode einer bestehenden Kampagne einen neuen Abschnitt hinzu.

mehr erfahren

Ändern eines Abschnittes einer Kampagne - UpdateSection

Verwenden Sie diese Methode, um die Informationen eines Abschnittes zu aktualisieren.

mehr erfahren

Löschen eines Abschnittes einer Kampagne - DeleteSection

Mit Hilfe dieser Methode können Sie einen bestehenden Abschnitt einer Kampagne löschen.

mehr erfahren

Bilder einer Kampagne auslesen - GetImagesOfCampaign

Mit Hilfe dieser Methode können Sie alle Bilder einer Kampagne auslesen.

mehr erfahren

Neue SMS Kampagne erstellen - CreateSMSCampaign

Mit Hilfe dieser Methode, können Sie in mailworx eine neue SMS Kampagne erstellen.

mehr erfahren

Versandstatus von E-Mail Kampagnen abfragen - GetSendActionInProgress

Mit dieser Methode können Sie abfragen, ob der Versand von E-Mail Kampagnen an einen Abonnenten schon abgeschlossen ist, oder ob der Versand noch in Arbeit ist.

mehr erfahren

Newslettervorlagen

Auslesen vorhandener Newslettervorlagen über die API Schnittstelle - GetTemplates

Um Kampagnen erstellen zu können ist es erforderlich, die vorhandenen Newslettervorlagen zu kennen. Mit dieser Methode werden die verfügbaren Vorlagen ausgelesen.

mehr erfahren

Auslesen vorhandener Abschnitte einer Vorlage - GetSectionDefinitions

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.

mehr erfahren

Zentrale Inhalte

Auslesen vorhandener zentraler Inhalte über die API Schnittstelle - GetCentralSections

Mit dieser Methode können alle zentralen Inhalte einer bestimmten Newslettervorlage ausgelesen werden.

mehr erfahren

Erstellen eines zentralen Inhaltes - CreateCentralSection

Erstellen Sie mit dieser Methode einen neuen zentralen Inhalt.

mehr erfahren

Ändern eines zentralen Inhaltes über die API Schnittstelle - UpdateCentralSection

Aktualisieren Sie die im zentralen Inhalt enthaltenen Informationen.

mehr erfahren

Löschen eines zentralen Inhaltes - DeleteCentralSection

Benutzen Sie diese Methode um einen zentralen Inhalt zu löschen.

mehr erfahren

Statistik

Kampagnenstatistik über die API Schnittstelle - CampaignStatistics

Auslesen von Kampagnenstatistik-Informationen wie Rückläufer, Klicks oder auch Öffnungen.

mehr erfahren

Auslesen der Mailclient Typen über die API Schnittstelle - GetMailClientTypesOfCampaign

Auslesen der Mailclient Typen, welche zur Darstellung Ihrer Kampagne verwendet wurden.

mehr erfahren

Mandanten

Auslesen der verfügbaren Mandanten über die API Schnittstelle - GetAccounts

Mit dieser Methode können alle Mandanten auf die der aktuelle Benutzer Zugriff hat ausgelesen werden.

mehr erfahren

Benutzer

Alle Benutzer des aktuellen Mandanten auslesen - GetUsers

Lesen Sie alle Benutzer aus, welche auf den aktuellen Mandanten Zugriff haben.

mehr erfahren

Informationen über den aktuellen Benutzer auslesen - GetUserInformation

Rufen Sie diverse Informationen über den aktuellen Benutzer aus mailworx ab.

mehr erfahren

Sperrlisten

Importieren einer Robinsonliste - ImportRobinsonlist

Importieren Sie Robinsonlisten über einen oder mehrere Mandanten hinweg.

mehr erfahren

 

Eventmanagement

Auslesen von Veranstaltungsinformationen - GetEvents

Liest alle verfügbaren Veranstaltungen aus.

mehr erfahren

Erstellung einer Veranstaltung über die API Schnittstelle - CreateEvent

Erstellen Sie mit dieser Methode eine neue Veranstaltung.

mehr erfahren

Ändern einer Veranstaltung - UpdateEvent

Aktualisieren Sie diverse Informationen einer Kampagne mit dieser Methode.

mehr erfahren

Kopieren einer bestehenden Veranstaltung - CopyEvent

Erstellen Sie eine neue Kampagne auf Basis einer bereits bestehenden Kampagne.

mehr erfahren

Löschen einer Veranstaltung - DeleteEvent

Mit Hilfe dieser Methode können Sie eine bestehende Veranstaltung löschen.

mehr erfahren

Auslesen von Gästen einer Veranstaltung - GetEventGuestList

Verwenden Sie diese Methode, um die Gästeliste einer Veranstaltung abzurufen.

mehr erfahren

Mediendatenbank

Auslesen von Ordnern - GetMDBDirectories

Liest Ordner aus der Mediendatenbank aus.

mehr erfahren

Erstellen eines Ordners - CreateMDBDirectory

Erstellt einen Ordner in der Mediendatenbank.

mehr erfahren

Auslesen von Dateien - GetMDBFiles

Liest Dateien aus der Mediendatenbank aus.

mehr erfahren

Hochladen einer Datei - UploadFileToMDB

Lädt eine Datei in die Mediendatenbank hoch.

mehr erfahren