Anleitung: Magento 2 Schnittstelle für Rechtstexte einrichten

In diesem Leitfaden wird beschrieben, wie Betreiber eines Magento-2-Shops die Rechtstexte der IT-Recht Kanzlei abmahnsicher und automatisch per Datenschnittstelle einbinden und anschließend die Aktualisierungs-Automatik einrichten können.

I. Magento-2-Schnittstellenmodul herunterladen und installieren

1.) Laden Sie das Magento-2-Schnittstellenmodul als ZIP-Datei aus dem Adobe-Commerce-Marketplace von hier herunter https://commercemarketplace.adobe.com/itrechtkanzlei-itrechtkanzleiapi.html

2.) Entpacken Sie die Zip Datei in ein beliebiges Verzeichnis auf Ihrer Festplatte.
3.) Kopieren Sie den Ordner “app” in Ihr Magento Stammverzeichnis
4.)Deaktivieren Sie das Magento Caching (System -> Cache Management)
5.) Führen Sie auf der Konsole des Dokumentenverzeichnisses des Shops Folgendes aus:

php bin/magento setup:upgrade

6.) Aktivieren Sie das Magento Caching wieder (System -> Cache Management)

II. Modul im Magento-Backend einrichten

Rufen Sie das installierte Schnittstellenmodul im Magento-Backend auf.

Bei deutscher Lokalisierung findet es sich auf diesem Pfad: Shops -> Konfiguration -> Services -> IT-Recht Kanzlei API

Sie werden vor der erstmaligen Nutzung sodann gebeten, Zugangsdaten (Benutzername/Passwort) zu vergeben.

Diese Zugangsdaten sind sodann für die Authentifizierung und Zuordnung der Schnittstellenübertragung im Mandantenportal erforderlich.

III. Übertragen der Rechtstexte in den Magento-2-Shop

1.) Login ins Mandantenportal

Melden Sie sich nun mit Ihren Zugangsdaten im Mandantenportal der IT-Recht Kanzlei an.

2.) Einrichtung der Schnittstellenverbindung

Nach dem Login geht es an die Einrichtung der Datenschnittstelle.

Wählen Sie hierfür im rechten Seitenmenü unter der Überschrift „SCHNITTSTELLE den Punkt „Schnittstelle einrichten“ aus.

Sie gelangen nun auf die zentrale Benutzeroberfläche für die Schnittstellenverwaltung.

Wählen Sie aus dem Systemkatalog per Klick auf die Auswahl-Schaltfläche unter "ODER WÄHLEN SIE IHR SYSTEM" „Magento 2“ aus.

Klicken Sie auf „Weiter“.

Im nächsten Schritt werden Sie gebeten, die maßgeblichen technischen Schnittstellendaten einzugeben, mit denen die Schnittstellenverbindung hergestellt wird.

• Unter „Shop-Name“ können Sie der Schnittstelle einen beliebigen Namen geben, unter der sie sodann in Ihrer Schnittstellenverwaltung geführt wird.
• Unter „API-URL" tragen Sie Ihre Shop-URL (Startseite) ein.
• Unter „Benutzerkennung“ und „Passwort“ tragen Sie die zuvor im Modul vergebenen Zugangsdaten (s.o.) ein.

Klicken Sie nach Eingabe der Daten auf den grünen „Speichern“-Button.

3.) Konfiguration der zu übertragenden Rechtstexte

Nach Einrichtung der Schnittstellenverbindung werden Sie automatisch auf die Rechtstexte-Übertragungsseite weitergeleitet.

Sie finden hier eine Übersicht der für die Schnittstellenübertragung verfügbaren Rechtstexte:

Haben Sie Ihre Rechtstexte bisher nicht konfiguriert, sehen Sie unter „Anmerkung“ den Hinweis, dass vor der Übertragung zunächst eine Konfiguration des Rechtstextes erforderlich ist.

Wichtig: Sie müssen einen Rechtstext erst konfigurieren, bevor er per Schnittstelle übertragen werden kann.

Klicken Sie dafür auf das rote „Bitte konfigurieren“ (s. roter Pfeil im obigen Bild).

Sie werden nun in den Online-Konfigurator weitergeführt.

Nehmen Sie die Konfiguration vor, indem Sie den virtuellen Fragenkatalog durchgehen. Klicken Sie abschließend auf „Weiter“.

Nach der Konfiguration werden Sie auf die Rechtstexte-Übertragungsseite zurückgeleitet, für den Rechtstext ist die Anmerkung "Bitte konfigurieren" nun entfallen.

Wiederholen Sie den Vorgang, bis alle zu übertragenden Rechtstexte konfiguriert sind und die Anmerkung „Bitte konfigurieren“ bei keinem zu übertragenden Rechtstext mehr angezeigt wird:

Nach der Konfiguration der Rechtstexte können Sie diese nun über die eingerichtete Schnittstellenverbindung übertragen.

Aktivieren Sie hierfür durch Klick den „Übertragen“-Regler rechts für jeden Rechtstext:

Nach Betätigung eines Übertragungs-Reglers erhalten Sie jeweils oberhalb die Mitteilung, ob die Übertragung erfolgreich war:

Haben Sie alle Regler betätigt und sind diese auf „grün“ gestellt, haben Sie die Schnittstelleneinrichtung erfolgreich abgeschlossen.

FERTIG: Die Aktualisierungs-Automatik überprüft und aktualisiert bei Bedarf die Rechtstexte in Ihrem Magento-2-Shop und Sie können sich nun auf das Verkaufen und den Kundenservice konzentrieren.

4.) Schnittstellenstatus prüfen und Einstellungen ändern

Nach der Einrichtung der Schnittstelle und der Übertragung der Rechtstexte können Sie den Schnittstellenstatus jederzeit im rechten Seitenmenü unter „Schnittstellen verwalten“ (Nach Einrichtung der Schnittstelle wird der Menüpunkt in "Schnittstelle verwalten" umbenannt und dahinter ein grüner Haken angezeigt) prüfen und die Schnittstellenverbindung verwalten.

Wählen Sie hierfür nach Klick auf „Schnittstelle verwalten“ durch Klick auf die Sparte „Shop“ (Ihr frei gewählter Name für die Schnittstellenverbindung) die betroffene Schnittstelle aus:

Sie gelangen nun wieder in die Ansicht der aktiv übertragenen Dokumente und haben unterhalb der Übersicht unter „Einstellungen der Schnittstelle ändern“ die Möglichkeit, die Verbindungsdaten für die Schnittstelle (frei vergebener Shop-Name, API-Token, URL) bei Bedarf anzupassen:

Die Vergabe eines eigenen Namens für die Schnittstelle empfiehlt sich insbesondere, wenn mehr als ein Magento-Shop betrieben wird.

Dadurch ist direkt in der Schnittstellenverwaltung sichtbar welche Schnittstelle zu welchem Magento-Shop gehört.

IV. Rechtstexteausgabe im Magento-2-Shop

1.) Ausgabeformat im Magento-Shop

Nach erfolgreicher Einrichtung der Schnittstellenverbindung werden die übertragenen Rechtstexte im Magento-2-Shop in Blöcken und Seiten mit folgenden Bezeichnungen abgelegt:

• itrk-agb-DE-de
• itrk-widerruf-DE-de
• itrk-impressum-DE-de
• itrk-datenschutz-DE-de

Die Struktur ist also wie folgt:

itrk-[type]-[COUNTRY-language]

COUNTRY-language-Kürzel nach ISO 639-1, wobei Land in Großbuchstaben und Sprache in Kleinbuchstaben geschrieben ist.

Die Namen können durch den Shopbetreiber beliebig geändert werden. Ein Mapping/eine Zuordnung findet über die ID statt.

Die Inhalte der Blöcke werden in der Form in den Seiten eingebunden:

{{block class="Magento\Cms\Block\Block" block_id="1"}}

Dabei bezieht sich die block id (1) auf die angelegten Blöcke.

Das kann von Shop zu Shop unterschiedlich sein.

Änderungen oder das Hinzufügen von Typen und Blöcken in die Schnittstelle erfordern eine Anpassung der Programmierung.

2.) PDF-Anhänge in Bestellbestätigungen

Zu den Rechtstexten (AGB, Widerrufsbelehrung und Datenschutzerklärung) wird jeweils ein PDF übertragen. Die Widerrufsbelehrung und AGB werden automatisch als Anhang in der Bestellbestätigung hinzugefügt.

Die PDFs liegen in dem Ordner:

pub\media\itrk_pdf\[store_id]\[type].pdf

Die Variable [type] kann folgendes sein:

• agb
• widerruf
• impressum
• datenschutz