Brevo Newsletter Integration für Zen Cart deutsch - Installation & Konfiguration

Version 1.2.0
last update 2025-07-13

INHALTSVERZEICHNIS
Sinn und Zweck
Copyright
Installation
Konfiguration
Deinstallation

Sinn und Zweck dieses Moduls

Mit diesem Modul wird das Newslettersystem von Brevo (ehemals) Sendinblue DSGVO-konform im Shop integriert.
Kunden, die bei der Neuregistrierung im Shop die Checkbox Newsletter abonnieren ankreuzen, bekommen von Sendinblue das Double-Optin Bestätigungsmail und werden nach Anclicken des Bestätigungslinks in Ihre Sendinblue Liste eingetragen.
Übermittelt werden Emailadresse, Vorname und Nachname.

Damit auch Shopbesucher die Möglichkeit haben, den Newsletter zu abonnieren werden drei neue Define Pages mitgeliefert. Auf der Seite index.php?main_page=newsletter kann dann via Tools > Seiteneditor der Formularcode aus der Sendinblue-Administration eingefügt werden.
Nach Absenden des Formulars kommen die Besucher auf die Seite index.php?main_page=newsletter_confirm mit einem Hinweis auf das nun folgende Double-Optin Bestätigungsmail.
Wird der Bestätigungslink dann angeclickt, kommt zur Bestätigung die Seite index.php?main_page=newsletter_success, der Besucher bleibt also immer auf der Shopseite.

In der Sidebox Information kann ein Link zur Newsletteranmeldung aktiviert werden.

Eine Newsletterabmeldung erfolgt rein über die in den Sendinblue Mails enthaltenen Abmeldelinks, die gesamte Zen Cart interne Newsletterfunktionalität wird durch Sendinblue ersetzt.

Copyright

Copyright
(c) 2023-2025 webchills (www.webchills.at)
Portions Copyright (c) 2003-2025 Zen Cart

Lizenz:
This contribution is subject to version 3.0 of the GPL license available through the world-wide-web at the following url:
https://www.zen-cart-pro.at/license/3_0.txt
Danke, dass Sie dieses Modul gekauft haben.
Sie können es auf einer Domain Ihrer Wahl einsetzen.
Dies ist keine Freeware, eine Weitergabe oder Nutzung auf weiteren Domains ist nicht gestattet.

Installation

Voraussetzungen

Dieses Modul ist nur für Zen Cart 1.5.7j deutsch geeignet.
Stellen Sie sicher, dass Sie Ihren Shop auf 1.5.7j aktualisiert haben, bevor Sie dieses Modul installieren.

Es wird ein fertig konfigurierter aktiver Account bei Brevo benötigt.

Das Modul verwendet CURL zur Kommunikation mit der Brevo API, daher muss in Ihrer PHP Konfiguration CURL verfügbar und aktiviert sein.


WICHTIG:
Für den Einbau dieses Moduls sollten Sie über folgende Werkzeuge verfügen:

1) Ein guter Texteditor.
Damit ist nicht das in Windows enthaltene Notepad oder Microsoft Word gemeint.
Sie benötigen einen Texteditor, der utf-8 versteht und auch im Format utf-8 ohne BOM abspeichern kann.
Meine Empfehlung: UltraEdit (kostenlose 30 Tage Testversion verfügbar)
Ebenfalls gut geeignet ist der kostenlose Texteditor Notepad++

2) Ein Tool zum Vergleichen von Dateien
Bei der Installation dieses Moduls ist es erforderlich, dass Sie den Inhalt einiger Ihrer bestehenden Zen Cart Dateien mit dem Inhalt der neuen Moduldateien vergleichen und die Änderungen zusammenführen ("mergen").
Meine Empfehlung: BeyondCompare (kostenlose 30 Tage Testversion verfügbar)
Ebenfalls gut geeignet ist das kostenlose Programm WinMerge

Empfehlung:

Dieses Modul erst in einem Testsystem einbauen und dort konfigurieren/testen und endgültig an die eigenen Wünsche anpassen. Erst dann in einem Liveshop einsetzen! Sichern Sie unbedingt alle Dateien Ihres Shops per FTP und sichern Sie die Datenbank mit phpMyAdmin oder anderen geeigneten Tools!

Die Installation erfolgt in folgenden Schritten. Halten Sie diesen Ablauf ein!

1)
Vorbereitungen in Brevo

ID der Liste
Falls noch nicht geschehen, legen Sie in Ihrer Brevo Administration unter Kontakte > Listen eine Liste an, in die die Shopkunden später eingetragen werden sollen. Notieren Sie sich die ID dieser Liste.

Registrierungsformular
Legen Sie unter Kontakte > Formulare ein neues Registrierungsformular an, das dann später im Shop eingebunden wird.
Nennen Sie es z.B. Newsletteranmeldung Onlineshop
Fügen Sie in das Formular die Attribute Vorname und Nachname ein.
Als Liste für das Formular wählen Sie Ihre zuvor erstellte Liste.
Bei den Formulareinstellungen kreuzen Sie Double-Opt-In Email an.
Als Vorlage wählen Sie Standard-Vorlage für Double-Optin oder falls Sie bereits ein eigenes Double Optin Template erstellt haben, das entsprechende gewünschte Template.
Bei Bestätigungsseite nach Absenden des Formulars tragen Sie ein:
https://www.meinshop.de/index.php?main_page=newsletter_confirm
Ersetzen Sie www.meinshop.de mit der Adresse Ihres Shops
Bei Bestätigungsseite nach Klicken auf den Bestätigungslink in der E-Mail tragen Sie ein:
https://www.meinshop.de/index.php?main_page=newsletter_success
Ersetzen Sie www.meinshop.de mit der Adresse Ihres Shops
Falls gewünscht kreuzen Sie auch Finale Bestätigungs-Email an.
Stylen Sie das Formular ansonsten so wie Sie es haben wollen.
Unter Teilen gehen Sie unter Einbetten auf den Reiter HTML
Kopieren Sie den gesamten angezeigten Code heraus und speichern Sie ihn in einer Textdatei.

ID des Templates
Notieren Sie sich unter Kampagnen > Templates die ID des Templates Standard-Vorlage für Double-Opt-in-Bestätigungen oder falls Sie im Formular ein anderes Template gewählt haben, die ID dieses Templates

API-Key
Clicken Sie oben rechts in der Brevo Administration auf Ihren Benutzernamen und wählen Sie SMTP & API
Im Reiter API-Schlüssel generieren Sie einen neuen API Schlüssel und nennen ihn z.B. zencart
Notieren Sie sich Ihren API-Schlüssel

Kontaktattribute
Prüfen Sie unter Kontakte > Einstellungen > Kontaktattribute ob die Attributnamen VORNAME und NACHNAME bereits vorhanden sind. Falls nicht fügen Sie sie als Textattribute hinzu. Sollten die Attributnamen für Vorname und Nachname bereits vorhanden sein und anders heißen als VORNAME und NACHNAME notieren Sie sich die beiden Attributnamen.

2)
Im Ordner NEUE DATEIEN alle Ordner namens DEINTEMPLATE auf das im Shop verwendete Template umbenennen (z.B. responsive_classic). Den Ordner DEINADMIN auf den Namen Ihres admin Verzeichnisses umbenennen.

3)
In die Zen Cart Administration einloggen

4)
Überprüfen Sie nun erst nochmal ob Sie wirklich in Schritt 2 die Ordner in NEUE DATEIEN entsprechend umbenannt haben.
Ja?
Dann nun alle Dateien/Ordner aus dem Ordner NEUE DATEIEN in der vorgegebenen Struktur in die Zen Cart Installation hochladen.
Dabei werden keine bestehende Dateien überschrieben.

5)
In der Zen Cart Administration auf irgendeinen Menüpunkt clicken. Sie sollten oben grüne Erfolgsmeldungen sehen und unter Konfiguration ist nun der neue Menüpunkt "Brevo" vorhanden.

6)
Im Ordner GEAENDERTE DATEIEN befinden sich Beispieldateien für die Dateien, die von diesem Modul geändert werden.
Falls Sie das responsive Standardtemplate responsive_classic aktiv haben, verwenden Sie die Dateien im Ordner DEINTEMPLATE_RESPONSIVE.
Für alle anderen Templates, verwenden Sie die Dateien im Ordner DEINTEMPLATE
Wenn Sie Zen Cart 1.5.7j gerade frisch installiert haben und noch keinerlei Änderungen an den Dateien vorgenommen haben, können Sie nun die Dateien aus dem Ordner GEAENDERTE DATEIEN in der vorgegebenen Struktur in die Zen Cart Installation hochladen und die bestehenden überschreiben.
Wenn Sie Zen Cart 1.5.7j schon länger im Einsatz haben und schon einmal Änderungen an Dateien vorgenommen oder andere Module eingebaut haben, dann laden Sie die Dateien keinesfalls einfach hoch.
Vergleichen Sie sie stattdessen mit der entsprechenden Datei in Ihrem Shop und nehmen Sie die Änderungen manuell per WinMerge oder BeyondCompare vor.
Dann spielen Sie die geänderten Dateien ein.

7)
Prüfen Sie in der Zen Cart Administration unter Konfiguration > Kundendetails den Wert für "Checkbox für Newsletter anzeigen".
Stellen Sie diesen Wert auf 1, damit die Checkbox Newsletter abonnieren auf der Registrierungsseite angezeigt wird.
Prüfen Sie in der Zen Cart Administration unter Konfiguration > Email Optionen den Wert für "Link "Newsletter abbestellen" anzeigen".
Stellen Sie diesen Wert auf false

8)
Integrieren Sie nun das Brevo Anmeldeformular.
Unter Tools > Seiteneditor schalten Sie rechts den internen HTML Editor um auf "Normaler Text"
Wählen Sie dann die Seite define_newsletter.php
Kopieren Sie den kompletten HTML Code aus Ihrer zuvor gespeicherten Textdatei ins Eingabeld und speichern Sie.
Diesen Code können Sie nur im Normaler Text Modus einfügen! Keinesfalls CKEditor oder Tiny MCE dafür verwenden!

9) OPTIONAL
Falls Sie das Modul Bestellen ohne Kundenkonto - COWOA im Shop integriert haben und die Newsletteranmeldung und Brevo Koppelung auch im COWOA Checkout integrieren wollen, finden Sie im Ordner OPTIONAL COWOA Vorlagen für die beiden Dateien, die Sie dafür in Ihrer COWOA Installation ändern müssen.

10)
Nehmen Sie nun unter Konfiguration > Brevo die restlichen Einstellungen vor:

KONFIGURATION

Einstellungsmöglichkeiten in der Zen Cart Administration

Unter Konfiguration > Brevo nun wie folgt vorgehen:

Brevo - Newsletter Define Pages
true oder false
Ist nach der Installation auf false gestellt.
Stellen Sie auf true um ihre Newsletteranmeldeseite zu aktivieren. Den Formularcode haben Sie ja bereits eingefügt.
Rufen Sie folgende Seite auf:
index.php?main_page=newsletter
Ihr Anmeldeformular sollte erscheinen, prüfen Sie die Funktionalität und tragen Sie sich testweise ein.
Nach Absenden Formulars erscheint die Seite
index.php?main_page=newsletter_confirm
Den Infotext auf dieser Seite können Sie unter Tools > Seiteneditor > define_newsletter_confirm anpassen
Clicken Sie den Bestätigungslink in Ihrem Double-Optin Mail an
Es erscheint die Seite:
index.php?main_page=newsletter_success
Den Infotext auf dieser Seite können Sie unter Tools > Seiteneditor > define_newsletter_success anpassen

Brevo - Newsletter Link in der Sidebox
Stellen Sie auf true, um in Ihrer Information Sidebox einen Link zu Ihrer Newsletteranmeldeseite zu aktivieren.
Falls Sie die Sidebox Information aktiv haben, prüfen Sie ob dort nun ein Link zur Newsletteranmeldeseite angezeigt wird.

Damit haben Sie nun die normale Newsletteranmeldung für Shopbesucher fertig konfiguriert.

Nun muss noch die Übermittlung der Daten im Hintergrund bei Registrierungen neuer Shopkunden konfiguriert und aktiviert werden:

Brevo - API Key
Tragen Sie hier Ihren zuvor generierten API Key ein

Brevo - Attribut für Vorname
Prüfen Sie ob Ihr Attributname für den Vornamen wirklich VORNAME lautet.
Falls erforderlich anpassen. Achten Sie auf exakte Schreibweise und Gross- und Kleinschreibung

Brevo - Attribut für Nachname
Prüfen Sie ob Ihr Attributname für den Nachnamen wirklich NACHNAME lautet.
Falls erforderlich anpassen. Achten Sie auf exakte Schreibweise und Gross- und Kleinschreibung

Brevo - ID der Liste
Tragen Sie hier die ID Ihrer Liste ein, die Sie sich zuvor notiert hatten.

Brevo - ID des Templates
Tragen Sie hier die ID des Templates ein, die Sie sich zuvor notiert hatten.

Brevo - URL zur Bestätigungsseite
Geben Sie die URL zu der Seite ein, zu der der User geleitet werden soll, nachdem er den Bestätigungslink im Double-Optin Email angeclickt hat. Verwenden Sie hier am besten die von diesem Modul mitgelieferte define page index.php?main_page=newsletter_success und tragen ein:
https://www.meinshop.de/index.php?main_page=newsletter_success
Ersetzen Sie www.meinshop.de mit der URL Ihres Shops

Brevo - Debug?
Stellen Sie das Debugging auf true, damit Sie nun einen Test durchführen können, um zu prüfen, ob Sie alles richtig eingestellt haben.
Später, wenn alles problemlos läuft, können Sie das Debugging dann wieder auf false stellen

Als letztes aktivieren Sie nun die Verbindung für die Datenübertragung bei Neuregistrierungen und stellen

Brevo - Verbindung aktivieren?
auf true

Führen Sie nun einen Test durch und machen Sie aus Kundensicht im Frontend eine Neuregistrierung im Shop mit einer Emailadresse, auf die Sie Zugriff haben.
Kreuzen Sie dabei die Checkbox Newsletter abonnieren an.
Im Ordner logs finden Sie danach ein Logfiles namens Brevo.log, das die Rückmeldung von Brevo protokolliert.
War alles ok, werden Sie einen Statuscode 201 oder 204 sehen mit einem entsprechenden Infotext.
Ist etwas falsch eingestellt, dann erhalten Sie einen Statuscode 400 mit einem entsprechenden Fehlergrund.
Bei 201 oder 204 haben Sie nun das Sendinblue Double-Optin Mail bekommen.
Bestätigen Sie die Anmeldung, Sie sollten dann auf die index.php?main_page=newsletter_success Ihres Shops geleitet werden.
Prüfen Sie nun noch, ob die Emailadresse mit Vorname und Nachname korrekt in Ihrer Sendinblue Administration unter Kunden vorhanden ist.

Wenn alles passt können Sie das Debugging wieder deaktivieren.

UPDATE VON VERSION 1.0.0 oder 1.1.0

Wenn Sie in Ihrem Shop bereits Version 1.0.0 oder 1.1.0 dieses Moduls verwendet haben, wird es automatisch auf Version 1.2.0 aktualisiert, wenn Sie so vorgehen wie unter Neuinstallation beschrieben und dabei etwaige bestehende Brevo Modul Dateien überschreiben. Dabei werden bei bestehender Konfiguration die Beschreibungstexte von Sendinblue auf Brevo geändert.

DEINSTALLATION

1.
Alle von diesem Modul neu angelegten Dateien vom Server löschen.
Alle von diesem Modul geänderten Dateien wieder mit den Originalversionen bzw. den Dateien Ihres Backups ersetzen.

2.
Die Datei uninstall.sql im Ordner SQL mit einem Texteditor öffen und den Inhalt kopieren

3.
Zen Cart Administration öffnen und unter Tools > SQL Patches installieren den Inhalt ins Feld hineinkopieren und absenden.