Einleitung zum E-Commerce-Integrations-Guide
Dieser Abschnitt gibt Ihnen eine Einführung in die Arbeit mit Optimizely Campaign und E-Commerce-Integrationen.
Mit Optimizely Campaign können Sie Werbeeinverständnisse für den Empfang von Newslettern in Ihrem E-Commerce-System erfassen, Transaktions-Mails versenden sowie Produktdaten importieren und für Mailings verwenden.
- Werbeeinverständnisse. Im Webshop eingehende Newsletter-Anmeldungen werden über Optimizely Campaign abgewickelt. Optimizely Campaign übernimmt das Handling der Opt-In- und Opt-Out-Prozesse sowie den Versand der Bestätigungs-E-Mails.
- Transaktions-Mails. Für den Versand einzelner E-Mails (Bestellbestätigungen, Registrierungen, etc.) bietet Optimizely Campaign entsprechende API-Operationen. Dazu werden Ihnen gesonderte Transaktions-Empfängerlisten angelegt, deren Struktur und Felder Sie definieren können. So profitieren Sie von den erhöhten Zustellraten beim Versand über Optimizely Campaign und können die Transaktions-Mails in Optimizely Campaign selbst gestalten.
- Produktdatenimport. Übertragen Sie den Produktkatalog Ihres Webshops mittels Content-Schnittstelle in Optimizely Campaign inklusive Bilder, Links und Preisen. Bei der Erstellung eines Newsletters können Sie diese Produktdaten einfach in das Mailing einfügen.
HTTP-API verwenden
Die HTTP-API von Optimizely Campaign bietet alle Funktionen, um Werbeeinverständnisse zu verwalten und Transaktionsmails zu versenden. Sie können sowohl einen Double-Opt-In-Prozess auslösen, Daten einer Empfängerliste ändern als auch einen Empfänger aus einer Liste austragen sowie Transaktions-Mails versenden.
Mandanten und Empfängerlisten
Ein Optimizely Campaign Mandant kann eine oder mehrere Empfängerlisten enthalten, die Sie zum Speichern von Empfängerdaten sowie für Transaktions-Mails verwenden.
Note
Wenden Sie sich für die Einrichtung und Konfiguration von Empfängerlisten an die Kundenbetreuung.
Sie können mittels HTTP-API Empfänger verwalten und Empfängerdaten in die Empfängerliste schreiben, aktualisieren und Empfänger aus der Liste entfernen. Werte in Feldern der Empfängerliste, wie beispielsweise Vor- und Nachname, können Sie über Feldfunktionen abrufen und in Mailings einfügen. Mit Feldfunktionen können Sie Ihre Mailings personalisieren; aus Hallo wird beim Versand beispielsweise Hallo Frau Müller.
Neben Empfängerlisten kann ein Mandant auch Mailing-Vorlagen enthalten, die für die Gestaltung von Mailings genutzt werden. Darüber hinaus dient ein Mandant zur Abwicklung von Opt-In- sowie Opt-Out-Prozessen.
HTTP-API aufrufen
Sie rufen die HTTP-API über den Endpoint api.campaign.episerver.net/ auf. In der Entwicklerdokumentation der HTTP-API auf Optimizely World finden Sie im Abschnitt Basics unter Formatting rules die gültigen Zahlen- und Datumsformate.
Sie rufen die API üblicherweise mit einem Programm oder über eine Programmbibliothek wie cURL auf. Für Testzwecke können Sie die API-Anfrage auch direkt in die Adresszeile Ihres Web-Browsers eingeben. Mit der POST-Methode versenden Sie Daten und mit der GET-Methode fordern Sie Daten an.
Ein vollständiger API-Aufruf hat folgenden Aufbau:
https://api.campaign.episerver.net/http/[Service]/[AuthorizationCode]/[Operation]?[Parameter]
- Service. Verwenden Sie für die Anbindung von Shop-Systemen und zum Verwalten von Profildaten die Dienste form und mail. Siehe Dienste und Operationen auf Optimizely World.
- AuthorizationCode. Der Autorisierungs-Code dient zur Zugriffsautorisierung der API und die mit dem Code verbundene Empfängerliste. Die Autorisierungs-Codes Ihrer Empfängerlisten finden Sie im Optimizely Campaign Menü unter Verwaltung > API-Übersicht > Empfängerlisten.
- Operation. Legen Sie fest, welche Aktion der API-Aufruf auslösen soll. Beispielsweise wird mit subscribe eine Anmeldung vorgenommen und ein Opt-In-Prozess ausgelöst. Mit sendtransactionmail versenden Sie eine Transaktions-Mail.
- Parameter. Sie müssen die zum API-Aufruf gehörenden Parameter korrekt angeben. Neben den für die Operation obligatorischen Parametern, wie bmRecipientId bei der Operation subscribe, können Sie auch die Namen von Empfängerlistenfeldern angeben - zum Beispiel lastname=Meier.
Tip
Die HTTP-API verwendet standardmäßig die Kodierung ISO-8859-1. Sie können die Kodierung ändern, indem Sie dem Parameter bmEncoding den Wert utf-8 zuweisen.
Zu Testzwecken können Sie die Operation nop verwenden. Die nop-Operation nimmt lediglich Parameter entgegen, führt aber keine Aktion aus. Sie können folgenden Aufruf zum Testen der Netzwerkverbindung zwischen dem Shop- oder Testsystem und Optimizely Campaign verwenden:
https://api.campaign.episerver.net/http/form/1234567890/nop?parameter=wert&bmEncoding=utf-8
Informationen in der API-Übersicht
Die zur Verwendung der HTTP-API notwendigen Informationen finden sie in der API-Übersicht.
- Empfängerlisten-ID. Wählen Sie im Optimizely Campaign Menü Verwaltung > API-Übersicht > Empfängerlisten.
- AuthorizationCode. Wählen Sie im Optimizely Campaign Menü Verwaltung > API-Übersicht > Empfängerlisten. Wählen Sie eine Empfängerliste aus und klicken Sie auf Autorisierungs-Codes verwalten.
- Mandanten-ID. Wählen Sie im Optimizely Campaign Menü Verwaltung > API-Übersicht > REST-API.
- Opt-In-Prozess-ID (bmOptinId). Wählen Sie im Optimizely Campaign Menü Verwaltung > API-Übersicht > Opt-In-Prozesse.