+49 69 83008980 service@xqueue.com
Benötigen Sie Hilfe?

Shopware 5

< Alle Themen

 

Integration mit Shopware 5

 

Einleitung

Das Modul synchronisiert Kundendaten zwischen Shopware und Maileon. Newsletter-Anmelder werden von Shopware nach Maileon synchronisiert und Abmeldungen werden aus Maileon an Shopware übergeben. Weiterhin können Transaktionsmails bei Änderungen der Bestellungen über das Backend/Plugins oder die API ausgelöst werden. Alle Funktionen sind über ein Konfigurationspanel in Shopware einstellbar.

Das Modul wird in der XQueue-Beispielinstanz http://dev-shop1000.maileon.com/shopware/ verwendet (Abbildung 1).


Abbildung 1: Beispielinstanz von Shopware
 

Inbetriebname des Moduls

Installation und Vorbereitung

1. Voraussetzungen prüfen
Das aktuelle Modulwurde mit Version 5.5 entwickelt und getestet. Für ältere Versionen bis Version 5.2 kann das Plugin in Version 1.1.0 verwendet werden (hier fehlen jedoch sämtliche Transaktions-E-Mails), für ältere Versionen ist das Modul leider nicht geeignet.

2. Modul installieren
Das Modul kann über „Einstellungen“ →„Plugin Manager“ →„Installiert“ →„Plugin hochladen“ zu Shopware hinzugefügt werden(Abbildung 2und Abbildung 3).
 

Abbildung 2: Installation des Moduls

Abbildung 3: Plugin Manager mit hinzugefügtem Maileon-Plugin

3. Abbildung 3 zeigt den Plugin Manage nach erfolgreichem Hinzufügen des Moduls.
Das Modul kann bereits jetzt über die rot markierte „Bearbeiten“-Schaltfläche konfiguriert werden oder zunächst über das grüne +-Symbol installiert und aktiviert werden.
Abbildung 4 zeigt das Modul nach erfolgreicher Aktivierung.
 

Abbildung 4: Plugin manager mit aktiviertem Maileon Modul

4. Das Modul muss nun nur noch durch Klick auf die „Bearbeiten“-Schaltfläche konfiguriert werden.

Abbildung 5: Konfigurationspanel des Maileon Moduls

Abbildung 5zeigt die Konfigurationsseite auf der zunächst der API-Key und eine Permission angegeben werden muss. Der API-Key kann im Maileon-Konto unter „Einstellungen“ → „Api-Keys“ erstellen und einsehen. Seit Version 1.1.0 ist das Plugin Sub-/Sprachshop-fähig. In den Einstellungen ist dann, wie in Abbildung 5 zu sehen ist, für jeden Subshop eine Konfiguration vorhanden.

Send subscribers to Maileon:
Wenn aktiviert werden Anmelder zum Newsletter an Maileon übertragen

API-Key:
Der Maileon API-Key der das Konto und die Zugriffsrechte identifiziert

Permissions:
• None: Keine Erlaubnis. Der Kontakt wird keine Emails erhalten.
• Single Opt-in: Erlaubnis wurde einfach gewährt, z.B. durch Eintrag einer Emailadresse in einem Formular. Diese Methode erlaubt es technisch den Kontakt zu beschicken, stellt jedoch nicht sicher, dass die Emailadresse der Person gehört, welche sie eingetragen hat.

• Double Opt-in: Bei dieser Erlaubnis wird eine Bestätigungsmail mit einem Bestätigungslink an die Emailadresse geschickt. Erst wenn der Link in der Mail angeklickt wurde und somit das Interesse an der Eintragung bestätigt wurde, kann der Kontakt beschickt werden.
• Double Opt-in Plus: Double Opt-in inclusive Einwilligung zum Einzelnutzertracking.
Bitte beachten: Ohne Einzelnutzertracking dürfen keine Öffnungen, Klicks, usw. getrackt werden und signifikante Daten zur Auswertung der Newsletterperformance fehlen.

Enable DOI Process:
Soll ein DOI-Mailing versendet werden muss diese Option auf „Yes“ stehen.

Enable DOI+ Process:
Soll, zusätzlich zu DOI, auch die Einwilligung zum Einzelnutzertracking nach dem DOI-Bestätigungslink gesetzt werden, muss diese Option auf „Yes“ stehen. DOI+ ist die Grundlage für viele Auswertungen auf Einzelnutzerbasis.

DOI key for simple subscribers:
Hier kann man einen DOI-Mailing-Schlüssel hinterlegen der bestimmt welches DOI-Mailing ausgelöst werden soll, sobald sich ein Gast zum Newsletter anmeldet. Der Schlüssel kann bei entsprechenden DOI-Mailing in Maileon konfiguriert oder ausgelesen werden.

DOI key for customer subscribers:
Hier kann man einen DOI-Mailing-Schlüssel hinterlegen der bestimmt welches DOI-Mailing ausgelöst werden soll, sobald sich ein Kunde zum Newsletter anmeldet. Der Schlüssel kann bei entsprechenden DOI-Mailing in Maileon konfiguriert oder ausgelesen werden.

Send transaction mails from Shopware:
Hier kann man festlegen, dass Shopware die Transaktionsmails selbst versendet.

Send DOI mails from Shopware:
Hier kann man festlegen, dass Shopware die DOI-Mails selbst versendet. Empfohlene Einstellung: no/nein.

Maileon API timeout:
Mit diesem Feld kann Timeout für erfolglose Aufrufe zwischen 5 und 30 Sekunden gewählt werde.

Maileon API Key for transactions:
Transaktionen können über ein anderes Maileon-Konto versendet werden um Permission-Probleme zu vermeiden. Wenn die Transaktionen über das gleiche Konto versendet werden, sollte darauf geachtet werden, dass diese mit SOI in Maileon angelegt werden. Newsletter sollten in diesem Fall an keine Kontakte mit SOI versendet werden.

Die nachfolgenden Punkte betreffen Transaktionsmails. Es ist zu beachten, dass die Transaktionen automatisch bei der ersten Verwendung angelegt werden. Wenn ein Mailing für eine Bestellbestätigung erstellt werden soll muss also zunächst der Menüpunkt aktiviert werden (Cache danach leeren!), dann kann eine Bestellung aufgegeben werden. In Maileon wird als Bestätigung ein Transaktionstyp angelegt auf basis dessen dann das Mailing erstellt werden kann.

“Send order confirmation mails from Maileon“:
Hier werden Bestellbestätigungen übermittelt.
Transaktionstypen:
• shopware_order_confirmation_cash_in_advanced_1.0
• shopware_order_confirm_cash_in_advanced_ext_1.0
• shopware_order_confirmation_customer_1.0
• shopware_order_confirm_customer_ext_1.0
• shopware_order_confirmation_guest_1.0
• shopware_order_confirm_guest_ext_1.0

“Send account confirmation mails from Maileon”:
Mails die mit der Accounterstellung und Verwaltung zusammen hängen.
• Hinweis: je nachdem ob DOI für die Account-Erstellung in Shopware aktiviert ist wird zunächst eine E-Mail mit Bestätigungslink versendet (shopware account confirmation) ansonsten wird sofort die Bestätigung geschickt und der Account aktiviert.
Transaktionstypen:
• shopware_account_change_email
• shopware_account_confirmation
• shopware_account_creation

“Send password reset mails from Maileon”:
Diese Option erlaubt es Mails mit einem Passwort-Änderungs-Link über Maileon zu versenden.
Transaktionstyp:
• shopware_password_reset
“Send password reset confirmation mails from Maileon”:
Bei Aktivierung wird über Maileon eine Bestätigungsmail einer Passwortänderung ausgelöst.
Transaktionstyp:
• shopware_password_reset_confirmation

“Send order and payment status mails from Maileon”:
Diese Option erlaubt es bei Statusänderungen der Bestellung, des Zahlungsstatus oder des Status eines einzelnen Items eine entsprechende Benachrichtigung über Maileon zu versenden.
• shopware_order_confirmation_cash_in_advanced
• shopware_order_confirmation_customer
• shopware_order_confirmation_guest
• shopware_order_status_acknowledgement_returns
• shopware_order_status_cancelled
• shopware_order_status_clarification_required
• shopware_order_status_completed
• order_status_completed_delivery_customer
• shopware_order_status_completed_delivery_guest
• shopware_order_status_in_process
• shopware_order_status_partial_cancellation
• shopware_order_status_partially_completed
• shopware_order_status_partially_delivery_customer
• shopware_order_status_partially_delivery_guest
• shopware_order_status_ready_delivery
• shopware_payment_status_completed_invoiced
• shopware_payment_status_completed_paid
• shopware_payment_status_delayed
• shopware_payment_status_encashment
• shopware_payment_status_first_reminder
• shopware_payment_status_no_credit_appr
• shopware_payment_status_partially_invoiced
• shopware_payment_status_partially_paid
• shopware_payment_status_recrediting
• shopware_payment_status_review_required
• shopware_payment_status_second_reminder
• shopware_payment_status_third_reminder

“Send shopping cart abandonment mails”
Hier wird definiert ob das vergessene Warenkörbe an Maileon zur weiteren Verarbeitung übermittelt werden sollen.
• shopware_abandoned_carts_1.0

After how many minutes should it be triggered after last cart change
Anzahl der Minuten bis ein Einkaufswagen als verwaist gilt. Empfohlene Einstellung: 120

Send to contacts without permission
Sollen Warenkorbabbrüche auch für Kontakte ohne Newslettereinwilligung an Maileon übertragen werden? Wenn ja muss diese Option aktiviert werden.

5. Bei Bedarf können über den Menüpunkt „Marketing“ → „Maileon Manager“ (Abbildung 6) auch aktuelle Newsletter-Anmelder eingesehen und alle Anmelder (auch vor Installation des Moduls) mit Maileon synchronisiert werden. Weiterhin zeigt der Manager die Einstellungen für die Webhooks an die in Maileon eingerichtet werden müssen.

6. Custom Contact Fields:
Für Custom-Formulare können, in einer durch Semikolon getrennten Liste, die Namen der Fehler definiert werden, welche an Maileon übergeben werden sollen. Die Schreibweise der Namen der Felder und der Custom-Fields in Maileon muss inklusive Groß- und Kleinschreibung identisch sein.
Wird ein Feld nicht in den Formulardaten gefunden, so wird es ignoriert. Existiert das Feld hingegen nicht in Maileon, so wird die API einen Fehler zurückgeben, welcher geloggt wird.
 

Abbildung 6: Maileon Manager im Menü „Marketing“

Abbildung 7: Webhook-Einstellungen in Shopware

Import aller Anmelder in Maileon
Im ersten Schritt muss die Erlaubnis (Permission) gewählt werden, welche die Kontakte beim Import in Maileon bekommen sollen. Im Unterschied zu den Einstellungen auf er Konfigurationsseite geht eine Massenübertragung jedoch davon aus, dass für jeden Kontakt eine entsprechende Erlaubnis vorliegt. Es wird keine DOI-Mail versendet, sondern die Kontakte werden mit der gewählten Erlaubnis direkt in Maileon eingetragen.

Durch Anklicken der “Send all”-Schaltfläche (Abbildung 8) wird der Prozess gestartet. Je nach Anzahl der Kontakte kann der Vorgang mehrere Minuten in Anspruch nehmen. Das UI benachrichtigt im Anschluss über Erfolg oder aufgetretene Fehler.

Abbildung 8: Importmaske für die Übertragung aller Kontakte

 

Übertragung von Kontaktdaten

Das Plugin überträgt eine Reihe von Kontaktdaten an Maileon. Darunter sind, sofern vorhanden, z.B. Vorname, Nachname aber auch die ID des (Sub-)Shops aus dem die Registrierung kommt. Dieses Kapitel enthält eine Auflistung aller übertragenen Kontakt-Informationen.
Kontaktfeld
Beschreibung
FIRSTNAME Vorname
LASTNAME Nachname
SALUTATION Anrede
ADDRESS Adresse inklusive Hausnummer
ZIP Postleitzahl
CITY Stadt
ORGANIZATION Unternehmen
BIRTHDAY Geburtstag
Shopware_NL Customfeld mit bool’schem Wert true (=Anmeldung kam aus Shopware)
Customergroup_key Die ID der Shopware-Gruppe welcher der Kontakt angehört
Customergroup_name Die Name der Shopware-Gruppe welcher der Kontakt angehört
shopware_store_id Die ID des (Sub-)Shops aus dem ein Kontakt stammt

 

Eigene Formulare zur Anmeldung

Das Plugin unterstützt neben den üblichen, von Shopware bereitgestellten, Anmeldemethoden auch angepasste An- und Abmeldeseiten. Dazu ist es wichtig, dass das Formular einen entsprechenden Marker bekommt:
Wird hier als „value“ der Wert 1 gesetzt, so handelt es sich um ein Anmeldeformular. Bei einer -1 handelt es sich um ein Abmeldeformular (die eingegebene E-Mail-Adresse würde abgemeldet).
Aktuell werden nur folgende Formularwerte übermittelt (Name der Inputs):
– email
– firstname
– lastname
– salutation
Weiterhin können Customfelder in das Formular eingefügt und an Maileon übermittelt werden. Hierzu ist jedoch eine Angabe in der Konfiguration (letzter Punkt Abbildung 5) notwendig.
Schließlich kann noch eine Weiterleitung im Erfolgsfall eingerichtet werden, indem ein verstecktes Formularfeld mit dem Namen „redirect“ eingefügt wird:

 

Einstellungen die in Maileon vorzunehmen sind

Um DOI-Bestätigungen und Abmelder mit Shopware zu synchronisieren kann in Maileon je ein Webhook für DOI-Bestätigungen und Abmelder eingetragen werden. Maileon Webhooks werden in Maileon unter “Einstellungen” → “Webhooks” konfiguriert. Wenn der Menüpunkt nicht vorhanden sein sollte kann ein Vertriebspartner oder Servicemitarbeiter diesen freischalten.

DOI-Bestätigungen
Es muss nun ein neuer Webhook für das Ereignis „DOI-Anmeldebestätigung“ hinzugefügt werden. Dazu muss die URL und die Webhook-ID aus dem „Maileon Manager“ (Punkt 5 im Installationskapitel und Abbildung 7) verwendet werden.
Der Webhook erwartet zwei Parameter:
1. email: Hier muss die Emailadresse des Kontaktes hinterlegt werden
2. code: Zur Absicherung wird der geheime Code an dieser Stelle eingefügt. Damit dieser nicht ausgelesen werden kann wird empfohlen eine SSL-verschlüsselte Verbindung zu wählen.
 

Abbildung 9: Einstellungen für den Abmelde-Webhook im Maileon Manager

Abmelder
Es muss nun ein neuer Webhook für das Ereignis „Abmelder“ hinzugefügt werden. Dazu muss die URL und die Webhook-ID aus dem „Maileon Manager“ (Punkt 5 im Installationskapitel und Abbildung 7) verwendet werden.
Der Webhook erwartet zwei Parameter:
1. email: Hier muss die Emailadresse des Kontaktes hinterlegt werden
2. code: Zur Absicherung wird der geheime Code an dieser Stelle eingefügt. Damit dieser nicht ausgelesen werden kann wird empfohlen eine SSL-verschlüsselte Verbindung zu wählen.
 

Abbildung 10: Einstellungen für den Abmelde-Webhook im Maileon Manager

Inhaltsverzeichnis

Bleiben Sie Up-to-Date und profitieren Sie von spannenden News und Aktionen.

Maileon ist ein Produkt der XQueue GmbH