beschreibung der schnittstelle zwischen mailingwork und ... · connect manager erreichen sie im...

mailingwork GmbH Fon: +49 (0) 37292/2882-0 Geschäftsführer: Commerzbank Freiberg

Birkenweg 7 Fax: +49 (0) 37292/2882-11 Torsten Gneuß, Jörg Arnold IBAN: DE 36 8704 0000 0305 0010 00

D-09569 Oederan [email protected] Amtsgericht Chemnitz, HRB 267 22 BIC: COBA DEFF XXX

www.mailingwork.de USt-IdNr.: DE 277 964 544

Dokumentation

Beschreibung der Schnittstelle zwischen

mailingwork und dem Magento Shopsystem bis

Version 1.9

Version: 1.1

Erstellt durch: Saskia Leupold

Datum: 21.11.2016

Seite 2 | Dokumentation

Inhalt

1 Voraussetzungen ............................................................................................................... 3

1.1 mailingwork .................................................................................................................. 3

1.2 Magento ....................................................................................................................... 3

2 Funktionen ......................................................................................................................... 4

2.1 Datenübertragung von Magento zu mailingwork .......................................................... 4

2.2 Datenübertragung von mailingwork zu Magento .......................................................... 5

3 Einrichtung der Schnittstelle in mailingwork ........................................................................ 6

3.1 Abonnentenliste ........................................................................................................... 6

3.2 Abonnentenfelder ......................................................................................................... 6

3.3 An- und Abmeldesetups ............................................................................................... 7

3.3.1 Anmeldesetup für nichtregistrierte Nutzer .............................................................. 7

3.3.2 Anmeldesetup für registrierte Kunden .................................................................... 7

3.3.3 Abmeldesetup ....................................................................................................... 7

3.4 Konfiguration in mailingwork ........................................................................................ 7

4 Einrichtung der Schnittstelle in Magento ............................................................................. 8

4.1 Erstlogin und Abrufen des Mappings ............................................................................ 9

4.2 Fieldmapping ............................................................................................................... 9

5 Anwendungsfall Multistore .................................................................................................10

5.1 Abonnentenliste ..........................................................................................................10

5.2 Zielgruppen .................................................................................................................10

5.3 Dublettenabgleich .......................................................................................................10


1 Voraussetzungen

1.1 mailingwork Im mailingwork-Account muss das Recht für den Webservice (SOAP 3) freigeschaltet sein.

Des weiteren müssen im Account die in Kapitel 3 genannten Abonnentenfelder und

eine Abonnentenliste angelegt werden.

1.2 Magento Das Plug-In wird über den Magento Connect Manager installiert. Den Magento

Connect Manager erreichen Sie im Backend unter System Magento Connect

Magento Connect Manager.

Danach muss das Plugin innerhalb von Magento aktiviert werden. Hierzu wird das

Modul im Magento Backend unter System → Configuration → Advanced →

Advanced aktiviert.


Nachdem das Modul aktiviert wurde, muss für die Kommunikation von mailingwork

zu Magento innerhalb von Magento noch ein Webservice-User inkl. entsprechender

Rolle angelegt werden. Die Benutzerrolle können Sie unter System → Web Services

→ SOAP/XML-RPC –> Roles neu anlegen und dieser folgende Rechte zuweisen:

Rechte der neuen Rolle:

Wurde die Rolle angelegt, wird in Magento noch ein Webservice-User unter System

→ Web Services → SOAP/XML-RPC – User mit der neuen Rolle angelegt. Der hier

vergebene Benutzername und API Key muss im weiteren Verlauf der Einrichtung

innerhalb von mailingwork in der Magento-Modul-Konfigurationsmaske eingetragen

werden.

2 Funktionen Die Schnittstelle überträgt Abonnentendaten zwischen den zwei Systemen. So

können Newsletter-Inhalte perfekt auf das Verhalten der Kunden abgestimmt werden.

2.1 Datenübertragung von Magento zu mailingwork Newsletter-Anmeldungen werden sofort von Magento zu mailingwork übertragen. Die

Anmeldung kann im Shop über zwei Wege geschehen, von dem die Art und Anzahl der zu

übertragenden Daten abhängt:

Newsletter-Anmeldung über das Shopformular:

Anmeldung für nicht registrierte Kunden


Übertragung von E-Mail-Adresse, Store-ID (bezogen auf Store-View)

Deaktivierter Status „ist Kunde“ in mailingwork

Newsletter-Anmeldung im Kundenkonto

Anmeldung als registrierter Kunde

Übertragen aller Daten, die im Shop-Backend zugeordnet werden können

Transaktionsdaten, Adressdaten

2.2 Datenübertragung von mailingwork zu Magento mailingwork überträgt Abmeldungen, die aus einem Newsletter heraus getätigt

werden zu Magento. Der registrierte Kunde hat im Kundenkonto die Möglichkeit, den

aktuellen Status seiner Newslettereinschreibung einzusehen. Somit wird zum einen

das erneute Anschreiben der Abonnenten verhindert. Zusätzlich erhält jeder

Abonnent die Möglichkeit, sich wieder für den Newsletter anzumelden.


3 Einrichtung der Schnittstelle in mailingwork Um eine lückenlose Datenübertragung zu gewährleisten, müssen in mailingwork zunächst

Abonnentenfelder, eine Abonnentenliste und An-/Abmeldesetups angelegt werden.

3.1 Abonnentenliste Abonnenten, die durch die Schnittstelle von Magento zu mailingwork übertragen werden,

sind in einer Abonnentenliste zu finden. Die Unterscheidung der Store-Zugehörigkeit läuft im

späteren Verlauf über ein Abonnentenfeld und Zielgruppen.

Erstellen Sie eine Abonnentenliste, in die alle Newsletter-Abonnenten und registrierte Nutzer

(mit Einwilligung) in den Newsletter der Shops importiert werden können.

3.2 Abonnentenfelder In mailingwork müssen für die korrekte Datenübertragung Abonnentenfelder mit folgenden

Feldtypen angelegt werden:

Feldbezeichnung Feldbezeichnung in Magento

Feldtyp in mailingwork

Abonnentendaten

E-Mail-Adresse email E-Mail-Adresse

Store-ID (für Multistore-Funktion)

store_id Einzeiliger Text

registrierter Kunde ist Kunde boolean

Vorname firstname Einzeiliger Text

Nachname lastname Einzeiliger Text

Anrede/Geschlecht gender Einfachauswahl

Datum letzter Login last_login_at Datum und Zeit

Titel (Optional, muss in Magento freigeschaltet werden)

prefix Einzeiliger Text

Kundengruppe group Einzeiliger Text

Rechnungsadresse (billingadress)

Rechnung_Firma company Einzeiliger Text

Rechnung_Titel /Anrede (Optional, muss in Magento freigeschaltet werden)


Rechnung_Vorname firstname Einzeiliger Text

Rechnung_Nachname lastname Einzeiliger Text

Rechnung_Straße street Einzeiliger Text

Rechnung_PLZ postcode Einzeiliger Text

Rechnung_Stadt city Einzeiliger Text

Rechnung_Land country Einzeiliger Text

Rechnung_Telefonnummer telephone Einzeiliger Text

Lieferadresse (shippingadress)

Liefer_Firma company Einzeiliger Text

Liefer_Titel /Anrede (Optional, muss in Magento freigeschaltet werden)



Feldbezeichnung Feldbezeichnung in Magento

Feldtyp in mailingwork

Liefer_Vorname firstname Einzeiliger Text

Liefer_Nachname lastname Einzeiliger Text

Liefer_Straße street Einzeiliger Text

Liefer_PLZ postcode Einzeiliger Text

Liefer_Stadt city Einzeiliger Text

Liefer_Land country Einzeiliger Text

Liefer_Telefonnummer telephone Einzeiliger Text

Transaktionsdaten

Anzahl Bestellungen count_orders Ganzzahl

Datum letzte Bestellung last_order_at Datum und Zeit

Bestellwert der letzten Bestellung

last_order_amount Dezimalzahl

Gesamtwert aller Bestellungen

all_order_amount Dezimalzahl

Durchschnittlicher Bestellwert

average_order_amount Dezimalzahl

Datum letzte abgebrochene Bestellung

last_abandoned_cart Datum und Zeit

3.3 An- und Abmeldesetups Da es über den Shop möglich ist, über zwei verschiedene Wege einem Newsletter-

Abonnement einzuwilligen, werden auch zwei verschiedene Anmeldesetups in mailingwork

benötigt. Zudem muss ein Abmeldesetup in mailingwork angelegt werden, worüber

Abonnenten die Zustimmung zum Newsletter revidieren können.

3.3.1 Anmeldesetup für nichtregistrierte Nutzer

Legen Sie ein Anmeldesetup für Newsletter-Anmeldungen über das Shop-Formular an.

Dieses beinhaltet die Liste aus Kapitel 3.1, sowie die Felder „E-Mail Adresse“, „Store-ID“ und

„registrierter Kunde“. Empfohlen wird ein Double-Optin mit Bestätigungsmail.

3.3.2 Anmeldesetup für registrierte Kunden

Dieses Setup ist für die Anmeldung während ein Kunde in seinem Shopkonto eingeloggt ist.

Das Setup muss neben der Abonnentenliste alle in Kapitel 3.2 genannten Abonnentenfelder

enthalten. Die Abonnentenliste wird im Reiter „Abonnentenlisten“ des Anmeldeformulars

ausgewählt.

3.3.3 Abmeldesetup

Das Anmeldesetup muss neben der in Kapitel 3.1 genannten Abonnentenliste das Feld „E-

Mail“ enthalten.

3.4 Konfiguration in mailingwork Für die Datenübertragung von mailingwork zu Magento werden im mailingwork-Menü unter

Extras Schnittstellen Magento Konfiguration die benötigten Daten eingetragen.

Dazu sind die Login-Daten des zuvor bei der Installation angelegten API-Nutzers notwendig.

Tragen Sie die Daten in die Konfiguration ein. Die Abbildung zeigt ein Beispiel dazu.


4 Einrichtung der Schnittstelle in Magento Um eine Lückenlose Datenübertragung zu gewährleisten, müssen in mailingwork zunächst

Abonnentenfelder, eine Abonnentenliste und An-/Abmeldesetups angelegt werden. Erst nach

erfolgreicher Installation des Plug-Ins in Magento und dem Anlegen der nötigen

Abonnentenfelder, Setups und der Liste in mailingwork kann die Einrichtung im Magento-

Backend beginnen.

Alle Einstellungen werden im Backend in den Standardeinstellungen für alle Store-Views

getätigt.

Name des angelegten Magento

Webservice Users

API Key des Magento

Webservice Users

>


4.1 Erstlogin und Abrufen des Mappings Das Plug-In ist im Magento Admin Account unter System Konfiguration (Customer)

Newsletter zu finden.

Die Einrichtung des Field-Mappings wird durch das Abrufen der Daten aus mailingwork

erleichtert. Dazu werden zunächst der Benutzername und das Passwort eingegeben und

gespeichert. Durch Speichern werden erstmals Daten aus mailingwork übertragen.

4.2 Fieldmapping Nach Erstabruf der Abonnentenfelder können nun Abonnentenliste, Setups und

Abonnentenfelder ausgewählt werden. Hierzu können Sie einfach die gewünschten Daten

über die Dropdown-Felder wählen, die alle in mailingwork angelegten Daten enthalten.

4.3 Initialimport

Sind in Ihrem Shop bereits Abonnenten für Ihren Newsletter angemeldet, empfiehlt es sich,

einen Initialimport aller Abonnenten nach mailingwork zu starten. Diese Funktion ist ebenfalls

im gleichen Menü zu erreichen, wie das Field-Mapping.

Wählen Sie dafür die vorgesehene Liste im Dropdown-Menü aus.

Hinweis: Um eine lückenlose Datenübertragung von Abmeldungen und eventuellen

Profiländerungen der zu importierenden Abonnenten zu gewährleisten, muss die selbe

Abonnentenliste gewählt werden, wie die im Fieldmapping.

Nach Start der initialen Datenübertragung im Shop-Backend wird in mailingwork dazu

automatisch ein Import-Job angelegt. Dieser kann im Menü Abonnenten Import

Übersicht letzte Importe eingesehen werden.


5 Anwendungsfall Multistore Das Magento Shopsystem stellt eine Multistore-Funktion zur Verfügung. Bei Nutzung dieser

Funktion mit verschiedenen Websites laufen mehrere Shops mit sogenannten Store Views

parallel über einen Administrator. Um dennoch eine zuverlässige Trennung der Abonnenten

beim Newsletterversand vornehmen zu können, ist Folgendes zu beachten.

5.1 Abonnentenliste Alle Abonnenten befinden sich auf einer Abonnentenliste. Die Unterscheidung, über welchen

Store-View die Abonnenten zugeordnet werden können, geschieht über das Feld „Store-ID“,

welches Sie bei der Konfiguration erstellt haben. Zudem ist das Feld „registrierte Kunden“

zur Sortierung der Shopkunden und reinen Newsletterabonnenten ohne Registrierung von

Ihnen bereits in mailingwork angelegt wurden.

Ausschließlich die von Ihnen in Magento gewählte Liste wird regelmäßig synchronisiert.

5.2 Zielgruppen Zur Unterscheidung der Abonnenten innerhalb von mailingwork können Zielgruppen

angelegt werden. Diese können beispielsweise minimal die Store-ID beinhalten. Die Inhalte

eines Mailings können ebenfalls an diese Zielgruppen gebunden werden, um den Newsletter

individuell auf die Abonnenten verschiedener Store Views abzustimmen.

Beim Versand von Mailings wird die Zielgruppe zusätzlich zur Abonnentenliste ausgewählt.

5.3 Dublettenabgleich Auch wenn für den Magento Multistore nur eine Liste genutzt wird, empfiehlt es sich,

regelmäßig einen Dublettenabgleich durchzuführen.

Erstellen Sie dafür am besten ein Dublettenabgleichsetup, welches für einen automatisierten

Abgleich genutzt werden kann. Wichtig ist, dass als Abgleichfelder die Abonnentenfelder für

„E-Mail-Adresse“ und „Store-ID“ gewählt werden

beschreibung der schnittstelle zwischen mailingwork und ... · connect manager erreichen sie im...

Documents