OXID-Integration
Note
Diese Funktion ist nur in der DACH-Region verfügbar.
Note
Dieses Kapitel richtet sich an Administratoren und Entwickler mit Administratorrechten in OXID.
Dieses Kapitel gibt eine Übersicht der OXID-Integration für Optimizely Campaign. Die gesamte Empfängerverwaltung von der Registrierung über den Opt-In-Prozess bis zur Aktualisierung der Empfängerdaten und der Abbestellungen wird in Optimizely Campaign durchgeführt. Die OXID-Integration ermöglicht den hochvolumigen, schnellen und sicheren Versand von Transaktions-Mails und regulären Mailings über Optimizelys Server.
Unterstützte Versionen
Community Edition | Professional Edition | | Enterprise Edition | |
|---|---|---|---|---|
nicht unterstützt | 4.7 4.8 4.9 4.10 | ✓ | 5.0 5.1 5.2 5.3 | ✓ |
Installation im Mandanten
Die Einrichtung der OXID-Integration in Ihrem Optimizely Campaign Mandanten nimmt die Optimizely Kundenbetreuung für Sie vor. Dazu benötigt Optimizely folgende Angabe:
- Empfängerdaten. Die Empfängerlisten Ihres Mandanten werden so angepasst, dass für jedes Datenfeld eine Spalte in der Empfängerliste vorhanden ist. Die Standardkonfiguration ist im Abschnitt Newsletter-Registrierung beschrieben.
- Produktdaten. Ihre Nachrichtenvorlage wird so konfiguriert, dass diese Daten in den Produkt-Paragaphen zur Verfügung stehen. Die Standardkonfiguration ist im Abschnitt Reguläre Kampagnen-E-Mails beschrieben.
- SSH-Schlüssel. Erstellen Sie ein Schlüsselpaar für die sichere Datenübertragung und übermitteln Sie den Public key sowie den Key fingerprint an Optimizely. Weiter Informationen finden Sie unter Dateiaustausch via SCP.
- Versanddomäne. Um den Versand von E-Mails über den Server zu ermöglichen, müssen Sie die Versanddomäne an Optimizely delegieren.
SMTP Konfiguration
Die Kundenbetreuung konfiguriert den SMTP-Server in Ihrem Mandanten für den Versand der System-Mails aus dem OXID-Shop. Sie erhalten einen SMTP-Benutzer und -Passwort, die Sie in den Grundeinstellungen Ihres OXID-Shops hinterlegen müssen. Geben Sie den Server smtpapi.campaign.episerver.net als SMTP-Server an.
Ersetzen Sie in dem System-Mailing, das Sie zur Anmeldebestätigung (Opt-In-Mailing) für Kunden aus Ihrem OXID-Shop nutzen möchten, die Standard-Feldfunktion für den Opt-In-Link: {Double-Opt-In-Link} durch folgenden parametrisierten Ausdruck:
{Double-Opt-In-Link}?cl=newsletter&fnc=addme&lang=${user.data.oxlangid}&confirm=${user.data.confcode}&uOptimizelyid=${user.data.oxid}OXID-Integration installieren
Für die Installation der OXID-Integration in Ihrem Webshop erhalten Sie eine Installationsdatei. Installieren Sie die Datei auf dem Server Ihres Shops über einen FTP-Zugangs.
- Speichern Sie das Installationspaket auf Ihrem PC.
- Entpacken Sie das Installationspaket.
- Stellen Sie eine FTP-Verbindung zu Ihrem OXID-Shop-Server her.
- Verschieben Sie das entpackte Installationspaket in das Root-Verzeichnis Ihres OXID-Shops.
- Wenn Sie über die Integration zusätzliche Bildgrößen und -formate für Produktbilder für den Versand in Mailings verfügbar machen möchten, muss die Bildgenerierung zusätzlicher Bildgrößen innerhalb von OXID aktiviert werden. Suchen Sie auf dem OXID-Server im Verzeichnis http/modules die Datei functions.php, öffnen Sie diese in einem Editor und fügen Sie den folgenden Code am Ende der Datei ein:
// Optimizely Campaign functions
include_once realpath( dirname( __FILE__ ) . '/optivo/functions.php');Note
Falls Sie eine ältere Version als OXID eShop Professional Edition 4.10 oder die OXID eShop Enterprise Edition 5.3 verwenden, konfigurieren Sie diese wie hier beschrieben: Konfiguration älterer Versionen.
Aktivieren Sie das Optimizely-Modul im Administrationsbereich Ihres Shops, indem Sie Erweiterungen > Module > optivo auswählen und im unteren Bereich auf Aktivieren klicken.
Note
Wenn Sie die Enterprise Edition von OXID verwenden und mit mehreren Mandanten arbeiten möchten, müssen Sie das Modul für jeden Shop-Mandanten einzeln aktivieren.
Konfiguration des OXID-Shops
- Wechseln Sie zu optivo broadmail > Einstellungen und wählen Sie Ihren Shop beziehungsweise in der OXID-EE-Version den Shop aus der Liste aus, den Sie konfigurieren wollen.
- Geben Sie im Reiter Stamm den Autorisierungs-Code ein. Der Autorisierungs-Code wird zur Authentifizierung bei der Übertragung der Registrierungsdaten an Optimizely Campaign benötigt. Sie finden den Autorisierungs-Code im Optimizely Campaign Menü unter Verwaltung > API-Übersicht > Empfängerlisten. Wählen Sie die Empfängerliste aus, in die die Registrierungsdaten übertragen werden sollen und klicken Sie auf Autorisierungs-Codes verwalten.
- Geben Sie im Reiter Stamm die Opt-In-ID ein. Sie finden die Opt-In-ID in Ihrem Optimizely Campaign Mandanten im Menü Verwaltung > API-Übersicht > Opt-In-Prozesse. Kopieren Sie dort aus der Liste die ID des gewünschten Opt-In-Mailings und fügen Sie diese in OXID im Feld Opt-In-ID ein.
- Wechseln Sie zum Reiter Artikel-Export und wählen Sie hier die Sprache der exportierten Datei aus. Die Option Artikel inklusive Varianten exportieren wirkt sich nur auf den Ad-Hoc-Export aus und wird für die Konfiguration nicht benötigt. Geben Sie im unteren Bereich des Panels die zusätzlichen Bildgrößen für den Export an. Die Generierung zusätzlicher Bildgrößen muss auf dem Server aktiviert sein, damit beim Export die Bilder in den hier angegebenen Größen erzeugt werden. Wenn Sie die Standardbildgrößen verwenden, müssen Sie hier nichts konfigurieren. Sie können jederzeit einen Ad-Hoc-Export starten, indem Sie auf Exportdatei generieren und hochladen klicken. Konfigurieren Sie ebenfalls den automatischen zeitgesteuerten Export zur Datenübertragung an Optimizely Campaign, um in festgelegten Intervallen die aktuellen Daten zu übertragen.
- Wechseln Sie zum Reiter Log-Export, um die Log-Datei der Newsletter-Anmeldungen aus dem OXID-Shop zu konfigurieren und herunterzuladen. Die Log-Datei enthält alle Empfänger, deren Daten nicht an Optimizely Campaign übertragen werden konnten, z. B. weil keine Verbindung zum Server hergestellt werden konnte. Geben Sie zunächst den Exportzeitraum an. Wenn Sie alle Daten, einschließlich solcher, die bereits exportiert wurden, einbeziehen möchten, aktivieren Sie die Option bereits exportierte Einträge einbeziehen.
- Um die Generierung der Log-Datei zu starten, klicken Sie auf Export starten. Nach dem erfolgreichen Export der Daten werden eine Erfolgsmeldung und ein Link zum Herunterladen der Exportdatei (CSV) angezeigt. Jeder Datensatz in der Log-Datei enthält eine Spalte mit einem Code, der die Empfängeraktion angibt:
- C. Empfänger wurde geändert
- U. Empfänger wurde abbestellt
- S. Neuer Empfänger
Es besteht die Möglichkeit, einen automatischen zeitgesteuerten Export auch für die Log-Datei einzurichten. Dabei werden die Empfängerdaten jedoch unverschlüsselt an die konfigurierte E-Mail-Adresse verschickt.
Warning
Verwenden Sie nicht den automatischen zeitgesteuerten Export für die Log-Datei. Der manuell angestoßene Ad-Hoc-Export ist als Standard-Fallback für die Integration definiert, um Abonnenten und Abbesteller, die nicht automatisch in Optimizely Campaign exportiert werden konnten, auf dem jeweils aktuellen Stand zu halten.
- Wechseln Sie zum Reiter sFTP Konfiguration und tragen Sie dort Benutzernamen, SSH-Key, Mandanten-ID sowie den Mandantennamen ein. Den Benutzernamen erhalten Sie von der Optimizely Kundenbetreuung. Im Feld SSH-Key muss der Private Key eines zuvor erzeugten Schlüsselpaares hinterlegt werden. Lesen Sie mehr unter https://support.optimizely.com/hc/de/articles/4413192168461Dateiaustausch via SCP.
- Konfigurieren Sie den Versand von System-E-Mails (z. B. Bestellbestätigungen) über den Optimizely SMTP-Server. Klicken Sie auf Stammdaten > Grundeinstellungen > Ihr Shop beziehungsweise in der OXID-EE-Version den Shop aus der Liste, den Sie konfigurieren möchten. Geben Sie im Reiter Stamm im rechten Bereich den SMTP-Server, SMTP-Benutzer und das SMTP-Passwort ein. Der Standard-SMTP-Server lautet: smtpapi.campaign.episerver.net. Benutzernamen und Passwort erhalten Sie von der Kundenbetreuung.
Produktdaten übermitteln
Mit dem automatischen zeitgesteuerten Export werden Produktdaten aus Ihrem OXID-Shop in festen Intervallen an Optimizely Campaign übermittelt.
- Stellen Sie eine FTP-Verbindung zu Ihrem OXID-Shop-Server her.
- Richten Sie auf dem Server einen Cronjob ein, der im gewünschten Zeitintervall, z. B. einmal täglich, die Datei optivo_artikel_export_cron.php aufruft. Diese Datei ist im Installationspaket enthalten. Der Aufruf der Cronjobs erfolgt nach folgendem Schema:
sudo php [oxidRoot]/http/modules/optivo/optivo_article_export_cron.php [shopId] [exportVariants]Ersetzen Sie den Term [oxidRoot] durch die Basis-URL Ihres OXID-Shops und den Term [shopId] durch die ID Ihres Shops. Setzen Sie den Term [exportVariants] auf den Wert 0 oder 1, um zu steuern, ob Sie alle Artikel einschließlich der Varianten (setzen Sie in diesem Fall den Wert auf 1) oder nur eigenständige Artikel und Hauptartikel einer Variante exportieren möchten (setzen Sie in diesem Fall den Wert auf 0).
Hinweis für Nutzer von OXID-EE
Falls Ihr Shop multimandantenfähig ist und Sie pro Mandant einen Export ausführen möchten, müssen Sie die Datei optivo_artikel_export_cron.php für jeden Shop aufrufen. Fügen Sie dabei jeweils die entsprechende Shop-ID ein. Im folgenden Beispiel wurden drei Shops mit den IDs 1, 2 und 3 konfiguriert. Die Basis-URL lautet in diesem Beispiel /var/www/oxid. Für den Shop mit der ID 1 wird der Artikelexport für alle Artikel einschließlich der Varianten, für die anderen Shops nur der Export eigenständiger Artikel und Hauptartikel konfiguriert:
sudo php /var/www/oxid/http/modules/optivo/optivo_article_export_cron.php 67 1sudo php /var/www/oxid/http/modules/optivo/optivo_article_export_cron.php 68 0sudo php /var/www/oxid/http/modules/optivo/optivo_article_export_cron.php 69 0Empfänger verwalten
Newsletter-Registrierung
Die Registrierung für Ihren Newsletter erfolgt wie gewohnt über das Web-Anmeldeformular auf Ihrer Shop-Seite. Die Registrierungsdaten werden per HTTP-Request an Optimizely Campaign übertragen. Mit jedem Datensatz werden die folgenden Datenfelder übermittelt:
Feldname | Datentyp | Beschreibung | Pflichtfeld |
|---|---|---|---|
String | E-Mail-Adresse des Empfängers – dieses Feld ist zugleich die unique ID des Empfängers | ✓ | |
Anrede | String | Anrede (Herr/Frau) des Empfängers | ✘ |
Vorname | String | Vorname des Empfängers | ✘ |
Nachname | String | Der Nachname des Empfängers | ✘ |
Sprache | String | Die Sprache des Shops, über den sich der Kunde registriert hat | ✓ (wird automatisch übertragen) |
custom | String | Beliebige weitere Felder | ✘ |
oxlangid | String | OXID-interne ID zur korrekten Weiterleitung des Empfängers nach dem Opt-In beziehungsweise Abbestellung | ✓ (wird automatisch übertragen) |
oxid | String | OXID-interne ID des Shopkunden | ✓ (wird automatisch übertragen) |
confcode | String | OXID-interne Prüfnummer | ✓ (wird automatisch übertragen) |
Opt-In-Prozess
Bevor ein neu registrierter Empfänger einen Newsletter erhält, muss er mit einem Klick auf den Aktivierungs-Link in der Double-Opt-In-E-Mail bestätigen, dass er sich mit dieser E-Mail-Adresse angemeldet hat. Mit der OXID-Integration verwenden Sie einen erweiterten Double-Opt-In-Prozess von Optimizely Campaign. Der Opt-In-Status wird in der Empfängerliste mit Zeitstempel sowohl in Optimizely Campaign als auch in der OXID Datenbank gespeichert.
Abmeldung
Die Möglichkeit zur Abmeldung von einem Newsletter-Angebot wird vom Gesetzgeber vorgeschrieben. Ein Abmelde-Link muss in jeder versendeten E-Mail enthalten sein. Der Abmeldeprozess wird über Optimizely Campaign gesteuert. Alternativ können Sie Empfänger auch in OXID abmelden. Der Status Ihrer Empfänger wird zwischen OXID und Optimizely Campaign synchronisiert.
Empfängerdaten ändern
Newsletter-Empfänger können ihre Daten jederzeit über ein Web-Formular ändern. Die geänderten Daten werden automatisch in die Empfängerliste importiert, sodass dort immer die aktuellsten Daten vorgehalten werden.
Mailing-Versand
System-E-Mails versenden
Versenden Sie mit der OXID-Integration Bestellungen, Versandbestätigungen, Rechnungen und so weiter über die Versandinfrastruktur von Optimizely Campaign. Sie können Ihre Transaktions-Mails wie gewohnt in Ihrem OXID-System erstellen.
Reguläre Kampagnen-E-Mails
Für reguläre Versendungen stehen Ihnen in Optimizely Campaign alle Empfängerdaten sowie die Produktdaten aus Ihrem OXID-Shop-System zur Verfügung. Erstellen Sie damit reguläre Newsletter, Remarketing-Kampagnen, Empfehlungen und so weiter für Ihre Kunden und Newsletter-Empfänger. Die Mailings können mit den Empfängerdaten personalisiert und mit Produktdaten, Empfehlungen, Cross- und Upselling-Angeboten angereichert werden. Die OXID-Integration überträgt folgende Produktdaten an Optimizely Campaign:
Feldname | Beschreibung |
|---|---|
id | OXID-interne ID des Produkts |
name | Produktbezeichnung |
category | Hauptkategorie des Produktes |
isVariant | Dieses Feld gibt an, ob es sich um eine Variante eines Produkts (z. B. eine andere Farbe) handelt. |
oxparentid | Bei Varianten (s. o.) wird hier die ID des zugehörigen Produkts angegeben. |
oxartnum | Artikelnummer im OXID-Shop |
oxean | EAN (internationale Artikelnummer) des Produkts |
oxshortdesc | Kurzbeschreibung des Produkts |
oxprice | Produktpreis |
oxthumb | URL zum Thumbnail |
oxicon | URL zum Icon-Bild |
oxpic1 | URL zum Originalbild |
oxvarminprice | Bei Hauptartikeln enthält dieses Feld den geringsten Preis (z. B.: Hemd in verschiedenen Größen, ab 29,99 €). |
oxvarmaxprice | Bei Hauptartikeln enthält dieses Feld den höchsten Preis (z. B.: T-Shirt, von 19,99 bis 29,99 €). |
URL | Absolute URL zur Landing-Page des Produkts |
oxlongdesc | Produktbeschreibung |
image1...5 | Absolute URLs zu den benutzerdefinierten Bildgrößen gemäß den Einstelllungen in der OXID-Integration (siehe dazu auch die Abschnitte Installation und Konfiguration) |
Konfiguration älterer Versionen
Wenn Sie eine Vorgänger-Version von OXID eShop Professional Edition 4.10 oder OXID eShop Enterprise Edition 5.3 verwenden, müssen Sie für die korrekte Funktion von Transaktions-Mails folgende Code-Zeilen in der Datei class.phpmailer.php auskommentieren:
if($this->Sender == '') { $result .= $this->HeaderLine('Return-Path', trim($this->From)); }else{ $result .= $this->HeaderLine('Return-Path', trim($this->Sender)); }Fügen Sie zum Auskommentieren der Zeilen 967-971 vor und nach dem Code folgende Zeichen ein und speichern Sie die Datei:
/*if($this->Sender == '') { $result .= $this->HeaderLine('Return-Path', trim($this->From)); }else
{ $result .= $this->HeaderLine('Return-Path', trim($this->Sender)); }*/