A. Was macht das Plugin?


Das Zapier-Pugin bietet eine Anbindung des JTL-Shops an Zapier an. Dadurch können Ereignisse im Shop von Zapier weiterverarbeitet werden oder bestimmte Aktionen im Shop automatisiert werden.


B. Welchen Vorteil bringt mir das?


Mittels Zapier lassen sich viele unterschiedliche Plattformen einfach verbinden (derzeit ca. 2.000 Apps).  


Zum Beispiel könnte für jede Bestellung ein Eintrag in ein Google Sheet angelegt werden. Auch können andere Plattformen Aktionen im Shop auslösen, z.B. Kundeneinträge erstellen.


Beispiel Apps sind:


  • GMail
  • Outlook
  • Facebook
  • Twitter
  • Asana
  • Trello
  • Google Sheets
  • Slack
  • Kalender
  • Hubspot
  • Mailchimp
  • ...


1. Konfiguration


Das Zapier-Plugin hat aktuell vier Einstellungen:

  1. Zapier aktivieren
    Diese Einstellung aktiviert / deaktiviert das Plugin
    Wichtig: Webhooks lassen sich auch bei deaktiviertem Plugin noch erstellen und löschen
  2. API-Key
    Der API-Schlüssel für die Webhook-Anbindung
    Über diesen Schlüssel können sämtliche API-Methoden des Plugins genutzt werden, daher ist hier besonders auf Sicherheit zu achten! Der Schlüssel sollte nicht einfach zu erraten sein.
  3. Kunde per API erstellen löst Hook aus
    Diese Einstellung entscheided, ob ein über die API eingefügter Kunde den "Kunde registriert"-Hook auslöst.
  4. Maximale Fehlversuche
    Wie oft darf bei einem API-Aufruf ein falscher API-Schlüssel angegeben werden, bevor die IP-Adresse gesperrt wird?


2. Aktuelle Funktionen


Aktuell unterstütz das Plugin die folgenden Funktionen:

  • Hook-aufruf bei Shopbestellung
  • Hook-aufruf bei Kundenregistrierung
  • Anlegen von neuen Shopkunden


Um die Funktionen nutzen zu können, benötigst du zusätzlich zu einem Zapier-Account auch unsere Zapier-App. Dieser kannst du per Einladung über den folgenden Link beitreten: Zapier Einladungslink


Diese App verbindet das Zapier-Plugin des Shops mit der Zapier-Platform.


Bei der Einrichtung des Accounts in der App muss dann noch die Shop-URL und der API-Schlüssel angegeben werden.


Ein Beispiel zur Einrichtung eines Zaps kann hier gefunden werden: Beispielaufbau eines Zaps


3. Hinweise


Der API-Schlüssel sollte direkt nach der Installation auf einen sicheren Wert gesetzt werden, da der mitgelieferte Standardwert nicht sicher (da bei allen gleich) ist! Siehe Punkt 2!


3.1 Fußtexte


Fußtexte werden den Bestellungen hinzugefügt und sind für Rechnungen gedacht. In den Sprachvariablen des Plugins kann man den Inhalt anpassen, der dann per Plugin ausgefüllt und hinterlegt wird.

Aktuell gibt es drei Fußtexte zur Auswahl:

  1. ws_zapier_footer_de: Für Inlandbestellungen
  2. ws_zapier_footer_eu: Für Bestellungen innerhalb der EU
  3. ws_zapier_footer_au: Für Bestellungen aus dem EU-Außland


Für die Fußtexte stehen aktuell zwei Variablen zur Verfügung:

  1. $BEZAHLWEG$: steht allen drei Texten zur Verfügung und wird durch den Namen der Zahlungsart ersetzt
  2. $STEUERNUMMER$: steht nur _eu und _au zur Verfügung und wird durch die USTID des Kunden ersetzt


3.2 Sicherheit


Um ein gezieltes Herausfinden des API-Schlüssels zu verhindern, werden IP-Adressen mit zu vielen abgelehnten Aufrufen gesperrt. Die Anzahl dieser Aufrufe lässt sich im Backend einstellen.


Zusätzlich gibt es im Backend eine Übersicht über alle Adressen, die mindestens einen abgelehnten Versuch haben, die Anzahl ihrer Versuche und den Zeitpunkt des letzten Versuchs / der Sperrung. Dort können Adressen auch wieder freigegeben werden.


Dies schützt allerdings nicht davor, dass der API-Schlüssel erraten werden kann. Daher ist es sehr wichtig, einen sicheren API-Schlüssel zu verwenden! Tipps hierfür lassen sich auf verschiedensten Webseiten finden, unter anderem beim BSI für Bürger.

Eine Kombination aus Sicherem Schlüssel und den IP-Sperren schützt den Shop vor unerlaubten Zugriffen!


3.3 E-Mails


Nach dem Hinzufügen eines Kunden per API versendet Zapier eine E-Mail an den Kunden, damit dieser ein Passwort vergeben kann. Der Text der E-Mail kann im Shop-Backend eingestellt werden:


(System > E-Mails > Vorlagen > Kundenaccount per Zapier erstellt)

In der Vorlage werden zusätzlich zu den normalen Smartyvariablen eigene Platzhalter mitgegeben:


  • [PASSWORDRESETLINK] - für den Passwortreset-Link
  • [ANREDE] - für die Anrede des Kunden, Kann per Sprachvariable angepasst werden


Der Passwortreset-Link führt den Kunden zur "Passwort Vergessen"-Seite des Shops, auf der er dann seinem neu erstellten Account ein Passwort zuweisen kann.


3.4 Kupons


Kupons werden der Bestellung als Kuponartikel mit negativem Preis hinzugefügt, damit diese von Rechnungsprogrammen korrekt abgezogen werden. Im Gegensatz zu Artikeln haben Kuponartikel keine Artikelnummern.


3.5 Beispiele für die Übermittelten Daten


Das Plugin übermittelt die Daten im JSON-Format. Beispiele können hier angesehen werden:


Beispiele für übermittelte Daten


(Hinweis: Diese Beispiele sind aktuell noch nicht kommentiert, sondern nur reine JSON-Angaben)