JTL Shop 5 Plugin

Mit diversen Extensions

Unser Plugin für die Integration verschiedener Tools:

  • Einbindung der AUSGEZEICHNET.org Siegel und Trust-Badges.
  • Einbindung der Widgets für die Präsentation von Score und Bewertungen.
  • Bewertungseinladungen via Invite API.

Hier können Sie die aktuelle Version unseres

JTL Plugins herunterladen.

v1.0.2 🆔 Plugin-ID: ausgezeichnet_jtl5 🛒 JTL-Shop 5.5.0 – 5.9.9 🏢 AUSGEZEICHNET.org

Das Plugin verbindet den JTL-Shop mit AUSGEZEICHNET.org:

  • zeigt Bewertungs-Widgets (Siegel, Badge, Modal, Slider, Carousel, Produktbewertungen) im Shop an,
  • fügt personalisierte Bewertungslinks in Transaktions-E-Mails ein,
  • versendet automatisch Bewertungseinladungen über die AUSGEZEICHNET.org API, sobald eine Bestellung einen bestimmten Status erreicht.

1. Installationsanleitung

1.1 Voraussetzungen

  • JTL-Shop 5.5.0 – 5.9.9
  • Ein AUSGEZEICHNET.org Account mit Zugriff auf das Kundencenter
  • Für Feature „Automatische Einladung": ein AUSGEZEICHNET.org API-Schlüssel (im Kundencenter erstellbar)
  • Für „Manuelle Shop-Bewertungseinladung" (Tools & Setup): AUSGEZEICHNET.org PROFESSIONAL-Plan

1.2 Plugin hochladen und aktivieren

  1. Admin-Backend → Plugins → Übersicht → Plugin hochladen
  2. ausgezeichnet_jtl5.zip auswählen und hochladen
  3. Plugin in der Liste aktivieren
  4. Beim ersten Aktivieren legt das Plugin automatisch die Tabelle xplugin_ausgezeichnet_jtl5_invites an (Migration Migration20260629000001). Das ist die Tracking-Tabelle für die automatische Einladung (siehe Abschnitt 2.4) – hier ist keine manuelle Aktion nötig.
Plugin hochladen im JTL-Shop Admin

1.3 Grunddaten eintragen (Tab „Grundeinstellungen")

Alle Werte findest du im AUSGEZEICHNET.org Kundencenter:

Feld Bedeutung
Organisation-ID Wird für die Widget-Script-URLs benötigt. Ohne diesen Wert werden keine Widgets geladen.
Kontonummer Kundencenter → Kontonummer. Fließt in die Hash-Berechnung der Bewertungslinks ein.
Bewertungs-ID Kundencenter → Bewertungs-ID. Ebenfalls Teil der Hash-Berechnung.
Bewertungs-URL Basis-URL für personalisierte Bewertungslinks. Nur Schema+Host+Pfad eintragen, keine Query-Parameter – vorhandene werden automatisch entfernt. Muss https:// sein.
API-Schlüssel Nötig für die automatische Einladungs-Funktion. Kann alternativ per Umgebungsvariable AUSGEZEICHNET_API_KEY gesetzt werden (überschreibt den Wert aus dem Backend – praktisch für getrennte Staging-/Live-Systeme).
Sprach-Override Optional, z. B. de oder en. Leer lassen für automatische Erkennung aus der Shop-Sprache.
Tab Grundeinstellungen

1.4 Installation prüfen

Tab Tools & Setup öffnen (letzter Reiter des Plugins) → Abschnitt „Konfigurationsstatus" zeigt für jedes Pflichtfeld /.

✅ Erst wenn alle fünf Punkte grün sind, funktionieren Widgets, E-Mail-Links und automatische Einladungen vollständig.
Konfigurationsstatus in Tools & Setup

Damit ist die Installation abgeschlossen. Die eigentliche Funktionskonfiguration erfolgt in den Tabs „Widgets", „E-Mail Bewertungslink" und „Automatische Einladung" – siehe Betriebsanleitung.

2. Betriebsanleitung

Das Plugin hat 5 Admin-Tabs. Änderungen an Selectbox-/Text-Einstellungen wirken sofort, ohne dass der Shop-Cache manuell geleert werden muss.

2.1 Tab „Widgets"

  • Schwebendes Siegel/Badge „Dynamic Seal" und „Trust Badge" schließen sich gegenseitig aus – nur eines aktivieren.
  • Review Modal / Collector / Slider / Carousel Jeweils eigenständig aktivierbar. Erfordern ein Platzhalter-Element im Shop-Template (ID/Attribut laut AUSGEZEICHNET.org Dashboard) – ohne passenden Platzhalter erscheint nichts, obwohl das Skript geladen wird.
  • Produkt-Bewertungswidget Zeigt Bewertungen auf Produktseiten, liest SKU/GTIN aus den Produkt-Datenattributen des Templates. Darstellungstyp (Badge/Hero/Horizontal) separat wählbar.
  • Review Collector (Legacy) Nur auf ausdrückliche Empfehlung des AUSGEZEICHNET.org Supports aktivieren.
  • Ausgeschlossene Seiten Eine URL-Teilzeichenkette pro Zeile (z. B. /bestellvorgang, /mein-konto, /warenkorb). Auf passenden Seiten werden keine Widgets geladen – die Einwilligungs-Checkbox (siehe 2.3) wird davon nicht beeinflusst und weiterhin angezeigt.
💡 Alle aktivierten Widget-Skripte werden pro Seitenaufruf einmal vor eingefügt (Hook HOOK_SMARTY_OUTPUTFILTER).
Tab Widgets

2.2 Tab „E-Mail Bewertungslink"

Fügt einen Bewertungsblock (Text + Button + optionales Siegel-Bild) in Transaktions-E-Mails ein. Es gibt zwei unabhängige Wege – einen davon wählen, nicht kombinieren:

Option A – Automatisch injizieren (empfohlen)

  1. Tab Tools & Setup öffnen
  2. Abschnitt „E-Mail Bewertungsblock – Auto-Setup" → Button „▶ Bewertungsblock einfügen" klicken
  3. Das Plugin hängt an die ausgewählten E-Mail-Templates (temailvorlage) einen mit markierten Smarty-Snippet an
  4. Über „✕ Bewertungsblock entfernen" lässt sich das wieder rückgängig machen

Die Tabelle in diesem Abschnitt zeigt, welche der drei Templates (Bestellbestätigung, Versandbestätigung, Rechnung) bereits injiziert sind.

Auto-Setup E-Mail Bewertungsblock

Option B – Manuell im Template einbinden

In ein beliebiges E-Mail-Template einfügen:

{ausgezeichnet_email_block kBestellung=$oBestellung->kBestellung collmethod="pos"}
  • collmethod="pos" → Point of Sale (z. B. Bestellbestätigung / Rechnung)
  • collmethod="af" → After Fulfillment (z. B. Versandbestätigung)
💡 Steuerbar über die drei Selectboxen „In Bestellbestätigung/Versandbestätigung/Rechnungs-E-Mail einfügen" (wirken nur auf Option A), sowie Blocktext, Button-Beschriftung und optionale Siegel-Bild-URL (muss https:// sein).

2.3 Tab „Automatische Einladung"

Versendet automatisiert Bewertungseinladungen über die AUSGEZEICHNET.org Invite-API.

  • Automatische Einladung aktiviert Hauptschalter.
  • Trigger: Nach Zahlung/Rechnung Löst aus, wenn die Bestellung Status „In Bearbeitung" erhält.
  • Trigger: Nach Versand/Abschluss Löst aus, wenn die Bestellung Status „Versandt/Abgeschlossen" erhält. Sinnvoll bei digitalen Produkten oder wenn „In Bearbeitung" übersprungen wird.
  • Verzögerung in Tagen (0–30) Wartezeit, die AUSGEZEICHNET.org selbst einhält, bevor die Einladungs-E-Mail verschickt wird (z. B. 7 Tage, damit das Paket ankommen kann).
  • Collection Method „After Fulfillment" oder „Point of Sale" – nur für die Shop-Bewertungseinladung relevant.
  • Shop-Bewertungseinladung senden Eine Einladung pro Bestellung für die Gesamt-Shop-Bewertung.
  • Produkt-Bewertungseinladungen senden Eine Einladung pro Bestellposition (SKU/Artikelnummer, Fallback: interne Artikel-ID).
  • Einwilligung erforderlich Wenn aktiviert: Checkbox im Checkout, standardmäßig nicht vorangehakt (Opt-in). Wenn deaktiviert: alle Kunden gelten als eingewilligt.
Tab Automatische Einladung
⚠️ Wichtig: Wenn „Automatische Einladung aktiviert" = Ja, aber kein Trigger aktiv ist, zeigt der Tab „Tools & Setup" eine Warnung an – in diesem Zustand wird nie etwas versendet.
⚠️ Wichtig: Wenn du die Einwilligung nutzt, prüfe den vorgeschlagenen Checkbox-Text unter „Text der Einwilligungs-Checkbox" rechtlich (DSGVO/TTDSG-Konformität liegt in eurer Verantwortung, nicht im Plugin).

2.4 Automatische Einladung: Idempotenz & Tracking

Beim Bestellabschluss (Hook HOOK_BESTELLABSCHLUSS_INC_BESTELLUNGINDB_ENDE) legt das Plugin pro Bestellung genau einen Datensatz in xplugin_ausgezeichnet_jtl5_invites an (E-Mail, Name, Einwilligung, Status). Beim Statuswechsel (Hook HOOK_BESTELLUNGEN_XML_BESTELLSTATUS) prüft das Plugin diesen Datensatz:

  • Kein Datensatz vorhanden → Bestellung existierte vor Plugin-Installation, Einladung wird übersprungen (Log-Eintrag „notice")
  • bConsent = 0 → Kunde hat nicht eingewilligt, keine Einladung
  • bSent = 1 → bereits gesendet, keine doppelte Einladung (auch bei mehrfachem Statuswechsel)

Erst wenn die API-Aufrufe erfolgreich waren, wird bSent = 1 und dGesendet gesetzt.

⚠️ Bei einem API-Fehler bleibt der Datensatz auf „nicht gesendet" stehen und es gibt aktuell keinen automatischen Retry – ein erneuter Statuswechsel (z. B. manuell im Backend Status kurz zurück- und wieder vorsetzen) würde einen neuen Versuch auslösen.

2.5 Tab „Tools & Setup"

  • Konfigurationsstatus: Live-Übersicht, ob Organisation-ID, Kontonummer, Bewertungs-ID, Bewertungs-URL und API-Schlüssel gesetzt sind
  • E-Mail Bewertungsblock – Auto-Setup: siehe 2.2a
  • Manuelle Shop-Bewertungseinladung: Einmalige Einladung an eine beliebige E-Mail-Adresse, unabhängig vom Bestellprozess. Erfordert einen konfigurierten API-Schlüssel und den AUSGEZEICHNET.org PROFESSIONAL-Plan.
🔒 Alle Formulare auf dieser Seite sind CSRF-geschützt (JTL-Admin-Token). Bei „Sicherheitstoken ungültig" die Seite neu laden und erneut versuchen (tritt meist nach sehr langer Inaktivität der Backend-Session auf).
Tab Tools & Setup

2.6 Monitoring & Troubleshooting

💬 Fehlgeschlagene API-Aufrufe und fehlende API-Schlüssel werden über das JTL-Log protokolliert, sichtbar unter Admin → System → Fehlerprotokoll/Logs. Log-Einträge sind mit dem Präfix [ausgezeichnet_jtl5] versehen.

Widgets erscheinen nicht

  • Organisation-ID prüfen
  • Aktuelle Seiten-URL gegen die Liste „Ausgeschlossene Seiten" prüfen
  • Bei Modal/Collector/Slider/Carousel: nötiges Platzhalter-Element im Template prüfen

E-Mail-Bewertungslink erscheint nicht

  • Bewertungs-URL, Kontonummer und Bewertungs-ID müssen gesetzt sein (Status-Tabelle in Tools & Setup)
  • Bei Methode 2.2a: prüfen, ob das Template als ✓ Ja markiert ist

Automatische Einladung wird nicht versendet

  • Hauptschalter aktiv?
  • Mindestens ein Trigger aktiv? (Warnhinweis in Tools & Setup beachten)
  • API-Schlüssel gesetzt?
  • Einwilligung des Kunden vorhanden? (bConsent)
  • Wurde bereits gesendet? (bSent)
  • Log auf HTTP-Fehler der AUSGEZEICHNET.org API prüfen

Änderungen wirken nicht sofort

  • Seite neu laden bzw. Browser-/Shop-Cache leeren, falls Seiten aus dem Cache ausgeliefert werden

2.7 Bekannte Einschränkungen

  • Kein automatischer Retry bei fehlgeschlagenen Einladungs-API-Aufrufen (siehe 2.4)
  • Die Einwilligungs-Checkbox wird anhand von URL-Mustern (/bestellvorgang, /checkout) bzw. Smarty-Seitentyp erkannt; bei stark angepassten Checkout-Templates ggf. die CSS-Selektoren in OutputFilterHook::maybeInjectConsentCheckbox() anpassen
  • Manuelle Einladung (Tools & Setup) und automatische Produkt-/Shop-Bewertungseinladungen erfordern unterschiedliche AUSGEZEICHNET.org Plan-Stufen – im Zweifel im Kundencenter prüfen