Dokumentation Kataloge anfordern (Plugin für Shopware)

Link zum Plugin: http://bit.ly/netzperfekt-kataloge

Automatisierung für den Katalog-Versand.

Das Plugin erlaubt es Ihren Nutzern im Shop, Kataloge und andere gedruckte Materialien kostenfrei anzufordern. Die Daten werden in einer separaten Datenbank gesammelt und können manuell oder automatisiert über eine Schnittstelle (API) abgerufen werden. So kann der Katalogversand vereinfacht oder an einen Versand-Dienstleister / Lettershop ausgelagert werden.

Installation und Einrichtung

Installieren Sie bitte das Shopware-Plugin wie gewohnt über den Plugin-Manager.
(Allgemeine Hinweise dazu finden sich unter http://community.shopware.com/Plugin-Manager-ab-Shopware-5_detail_1856_643.html). Bitte laden Sie nach der Installation und Aktivierung des Plugins das Backend neu, damit der Menüpunkt angezeigt wird. 

Im Shopware-Plugin selbst können einige Einstellungen vorgenommen werden:

  • E-Mail abfragen: optional können Sie die E-Mailadresse bei der Kataloganforderung abfragen. Dieses Feld ist jedoch immer freiwillig für den Nutzer und sollte im Sinne der Datensparsamkeit nicht unbegründet abgefragt werden.
  • In Newsletter eintragen: hierüber können Sie steuern, ob eine Newsletteranmeldung direkt bei der Kataloganforderung möglich sein soll. In jedem Fall wird dabei das in Deutschland gesetzlich vorgeschriebene Double-opt-in-Verfahren berücksichtigt.
  • ReCAPTCHA verwenden: möchten Sie das Formular gegen Bots und anderen automatischen Mißbrauch schützen, können Sie hier das „Ich bin kein Roboter“-Captcha von Google aktivieren. Sie benötigen dafür jedoch einen individuellen API-Key, den Sie unter https://developers.google.com/recaptcha/ kostenfrei anfordern können. Bitte tragen Sie den Websiteschlüssel und den geheimen Schlüssel dann in die dazugehörigen Konfigurationsfelder ein.  

Anlegen

Legen Sie zunächst fest, welche Kataloge Sie zur Anforderung anbieten möchten. Rufen Sie dazu im Backend den Menüpunkt Marketing / Kataloge anfordern / Katalog-Items aus.  

In diesem Fenster können Sie nun die gewünschten Kataloge anlegen. Hier muss mindestens der Code, Titel und ein Bild (einfach aus der Shopware-Medienverwaltung auswählen) eingetragen werden. Ist das Feld Vorauswählen angekreuzt, wird im späteren Anforderungsformular der jeweilige Katalog bereits als markiert gekennzeichnet.

Nun legen Sie eine neue Katalog-Anforderungsseite an. Legen Sie dazu eine normale Shopware Inhaltsseite an (Menüpunkt: Inhalte / Shopseiten). Den Titel können Sie frei wählen und ebenso einen beliebigen Text eingeben. Im Inhalt fügen Sie dann einen Smart-Kurzbefehl ein.

Das Katalog-Formular wird dann über einen Smarty-Kurzbefehl eingefügt und später bei der Darstellung automatisch ersetzt.

Hier stehen Ihnen zwei Befehle zur Verfügung:

(1)    {request}{/request}

(2)     {request items="code1,code2,code3"}{/request}

Der erste Befehl fügt ein Katalog-Formular in die Seite ein, das alle verfügbaren Kataloge zur Anforderung anbietet. Mit dem zweiten Befehl können Sie die Kataloge auf die angegebenen codes begrenzen (dieser Wert muss mit den eingangs angelegten Katalogen/Code übereinstimmen). Sie können hierüber also Anforderungsseiten anlegen, über die nur ein (oder mehrere) bestimmte(r) Kataloge angefordert werden können.

Achtung: bitte kopieren Sie die Smarty-Kurzbefehle nicht per copy & paste, sondern tippen Sie diese exakt wie angegeben ab. Es kann sonst vorkommen, dass falsche Format-Informationen mit kopiert werden, und der Befehl dann nicht funktioniert.  
Am Besten arbeiten Sie im HTML Quellcode, wie in den folgenden Screenshots gezeigt.


(Aktualisieren und dann die Seiten Speichern bitte nicht vergessen.)


Anschließend können Sie die neue Katalog-Anforderungsseite über die Shopware-URL aufrufen. Wenn Ihre angelegt Katalog-Seite etwa Kataloge heisst, ist diese URL dann www.IhrShop.de/Kataloge (es kann unter Umständen ein wenig dauern, bis die SEO-URLs neu aufgebaut wurden.)


Datenabruf und manuelles Hinzufügen

Es gibt mehrere Möglichkeiten, die Kataloganforderungen einzusehen und abzurufen:

  1. Im Backend
    Über den Menüpunkt Marketing / Kataloge anfordern öffnet sich ein Fenster mit allen bisherigen Anforderungen. Über die Spalte Status können Sie einsehen, ob der jeweilige Datensatz bereits abgerufen wurde (damit keine Kataloge doppelt verschickt werden.). Der Button Hinzufügen erlaubt es, eine Kataloganforderung auch manuell im Backend einzutragen, etwa durch Ihre telefonische Hotline. (An dieser Stelle ist aus technischen Gründen keine Newsletteranmeldung möglich.)
  2. Über den Button Neue exportieren können Sie direkt im Backend eine CSV-Datei mit allen neu eingetroffenen Kataloganforderungen abrufen. Nach dem Abruf werden die entsprechenden Datensätze als „abgerufen“ gekennzeichnet, so dass ein erneuter Aufruf keine doppelten Daten liefert. Der Button Alle exportieren lädt dagegen sämtliche vorhandenen Kataloganforderungen unabhängig vom Übertragungsstatus.
  3. Als API-Aufruf
    Um den Datenabruf automatisieren zu können, steht Ihnen folgende Schnittstelle zur Verfügung:

    www.IhrShop.de/api/netzprequest/requests

    Um diesen nutzen zu können, richten Sie bitte zunächst einen API-Benutzer (Einstellungen / Benutzerverwaltung) ein und aktivieren bei diesem Nutzer den API-Zugang. Es wird ein API-Schlüssel generiert, der zusammen mit dem Benutzernamen beim Aufruf der Daten-Schnittstelle eingegeben werden muss und Ihre Daten gegen einen unberechtigten Abruf schützt.

    Wenn Sie die Katalog über den obenstehen Link abrufen, erhalten Sie alle neuen Kataloganforderungen im JSON-Format. Über folgende URL-Parameter können Sie den Abruf zusätzlich steuern (Achtung: den ersten Parameter mit ? anhängen, weitere mit & trennen, also z.B.
    www.IhrShop.de/api/netzprequest/requests?format=csv&status=-1).

    format=csv          Abruf als CSV-Datei
    format=json         Abruf im JSON-Format
    status=-1           Ruft alle Datensätze ab
    status=0            Ruft neue Datensätze ab und setzt den Status
    status=1            Ruft bereits übertragene Datensätze ab
    country=ISOCODE     Ruft nur Anforderungen für ein bestimmtes Land ab (z.B. DE)
    country=!ISOCODE    Ruft nur Anforderungen ab, die nicht aus dem  angegeben Land stammen.

Statistik

Im Statistik-Modul steht Ihnen unter dem Menüpunkt Marketing / Auswertungen / Auswertungen / Katalog-Anforderungen eine kleine Statistik zur Verfügung, die Auskunft über die bisherigen Anforderungen gibt.


Wir wünschen Ihnen viel Erfolg 
mit unserem Plugin und 
gute Geschäfte mit Shopware.