Anleitung: Rechtstexte-Schnittstelle für TYPO3 einrichten
Dieser Leitfaden erklärt Ihnen Schritt für Schritt, wie Sie Ihre Rechtstexte über unsere Schnittstelle automatisch in Ihren TYPO3-Shop integrieren und stets aktuell halten.
Inhaltsverzeichnis
- I. Vorbereitungen im Typo3-Shop
- 1.) Anlegen von Unterseiten für Rechtstexte & Verlinkung im Seitenfooter
- 2.) Installation und Konfiguration des Schnittstellenplugins
- 3.) Einrichtung von Rechtstexte-Ordner und Zuordnung der ID
- 4.) Plugin-TypoScript im Shop hinterlegen
- 5.) Plugin auf Rechtstexte-Seiten einbinden
- 6.) Cache leeren
- II. Übertragung der Rechtstexte aus dem Mandantenportal in den TYPO3-Shop
- 1.) Einrichtung der Schnittstellenverbindung
- 2.) Konfiguration der zu übertragenden Rechtstexte
- 3.) Übertragen der Rechtstexte in den TYPO3-Shop
- 4.) Schnittstellenstatus prüfen und Einstellungen ändern
Hinweis: Ihr Impressum im Mandantenportal ist bereits mit den bei der Bestellung angegebenen Unternehmensinformationen versorgt. Prüfen Sie diese vor der Verwendung auf Richtigkeit und Vollständigkeit.
I. Vorbereitungen im Typo3-Shop
Loggen Sie sich zunächst in Ihren Typ3-Shop ein.
1.) Anlegen von Unterseiten für Rechtstexte & Verlinkung im Seitenfooter
Sofern noch nicht geschehen, müssen Sie in einem ersten Schritt eigenständige Unterseiten für Ihre Rechtstexte, nämlich jeweils eine für
- AGB mit Kundeninformationen
- Datenschutzerklärung
- Widerrufsbelehrung & Muster-Widerrufsformular
- Impressum
einrichten.
Wählen Sie hierfür im linken Seitenmenü "Seite" aus:
Neue Seiten erstellen Sie durch Drag und Drop, indem Sie auf das Seitenicon klicken und dieses in den unten angezeigten Pfad an die gewünschte Stelle ziehen:
Legen Sie die Seiten mit den oben genannten Bezeichnungen an und verlinken Sie diese anschließend im Fußzeilenmü (Footer) Ihres Shops.
2.) Installation und Konfiguration des Schnittstellenplugins
Laden Sie im zweiten Schritt das TYPO3-Schnittstellen-Plugin der IT-Recht Kanzlei herunter und installieren Sie es.
Nach der Installation ist das Plugin zunächst zu konfigurieren und mit von Ihnen selbst festgelegten API-Daten auszustatten. Diese API-Daten sind später für eine ordnungsgemäße Verknüpfung Ihres TYPO3-Shops im Mandantenportal der IT-Recht Kanzlei erforderlich.
Klicken Sie hierfür im linken Seitenmenü auf "Einstellungen" und sodann auf "Configure Extensions":
Wählen Sie nun das Schnittstellen-Plugin im Drop-Down aus und vergeben Sie unter
- "API username" einen eindeutigen Benutzernamen
- "API password" ein eindeutiges Passwort
nach eigenem Belieben.
Merken Sie sich die Kennungen gut, Sie benötigen Sie später zur Herstellung der Verbindung im Mandantenportal.
Speichern Sie die Konfiguration abschließend.
3.) Einrichtung von Rechtstexte-Ordner und Zuordnung der ID
Im nächsten Schritt muss im TYPO3-Shop-Pfad unter "Seiten" im linken Menü ein neuer Ordner eingerichtet werden, in welchem die zu übertragenen Rechtstexte gespeichert werden.
Ziehen Sie hierfür per Drag und Drop das Ordner-Symbol an die gewünschte Stelle und benennen Sie den Ordner nach Belieben, etwa "Rechtstexte-Storage":
Aktivieren Sie den Ordner durch Rechtsklick:
Fahren Sie nun mit dem Cursor über den Ordner, sodass Ihnen die Ordner-ID angezeigt wird:
Merken Sie sich die ID und navigieren Sie nun am linken Seitenmenü zu "Sites":
Klicken Sie hier im Eintrag auf den Bearbeitungsstift:
Navigieren Sie nun zum Tab "Rechtstexte" und tragen Sie die ID des soeben eingerichteten Ordners ein:
Klicken Sie abschließend oben auf "Speichern" ("Disketten-Symbol").
4.) Plugin-TypoScript im Shop hinterlegen
Nach der Konfiguration des Plugins muss das TypoScript des Schnittstellenplugins im Shop hinterlegt werden, um eine ordnungsgemäße Ausgabe der Rechtstexte zu ermöglichen.
Rufen Sie dafür im linken Seitenmenü "TypoScript" auf und wählen Sie die Skript-Definition Ihres Shop-Pfades ("Weltkugel-Symbol") aus:
Klicken Sie nun auf "den gesamten TypoScript Datensatz bearbeiten":
Unter dem Reiter "Erweiterte Optionen" klicken Sie nun auf "IT-Recht-Kanzlei - Legal Texts":
Sie sorgen so dafür, dass die Script-Datei unter "ausgewählte Objekte" erscheint:
Klicken Sie abschließend oben auf "Speichern" ("Disketten-Symbol").
5.) Plugin auf Rechtstexte-Seiten einbinden
Nachdem nunmehr das Schnittstellen-Plugin eingerichtet und ausgestaltet wurde, müssen Sie auf Ihren Rechtstexte-Unterseiten noch das Plugin so einbinden, dass die darüber übertragenen Rechtstexte auf diesen Unterseiten korrekt ausgegeben werden.
Rufen Sie dafür über "Seiten" im linken Seitenmenü die jeweilige Rechtstexte-Seite auf:
Wählen Sie nun im Bereich "Normal" die Schaltfläche "neuen Inhalt erstellen" aus (bzw. bei abweichender Bezeichnung: erstellen Sie über die maßgebliche Schaltfläche ein neues Inhaltselement):
Im sich öffnenden Menü wählen Sie "Plugins" aus und sodann die Option "Rechtstext":
Sie gelangen anschließend auf eine Einstellungsseite und wählen im Reiter "Plugin" unter "Typ" den Rechtstext aus, der auf die Seite übertragen werden soll:
Klicken Sie abschließend oben auf "Speichern" ("Disketten-Symbol") und wiederholen Sie den Vorgang für alle Rechtstexte-Unterseiten unter Zuordnung des jeweils einschlägigen Rechtstexts.
6.) Cache leeren
Nach Abschluss aller oben genannten Schritte sollte zur Konsolidierung der neuen Einstellungen der Cache im TYPO3-Shop einmal vollständig gelöscht werden.
Klicken Sie dafür im allgemeinen TYPO3-Menü oben rechts auf das "Blitz"-Symbol und dann auf "Alle Caches leeren":
II. Übertragung der Rechtstexte aus dem Mandantenportal in den TYPO3-Shop
Melden Sie sich nun mit Ihren Zugangsdaten im Mandantenportal der IT-Recht Kanzlei an.
1.) Einrichtung der Schnittstellenverbindung
Nach dem Login geht es an die Einrichtung der Datenschnittstelle.
Wählen Sie hierfür im rechten Seitenmenü unter der Überschrift „IHRE RECHTSTEXTE“ den Punkt „Schnittstelle einrichten“ aus.
Hinweis: Haben Sie bereits eine andere Rechtstexte-Schnittstelle eingerichtet, heißt der Menüpunkt "Schnittstelle verwalten".
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" Ihr Zielsystem 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 Ihrer Präsenz, z.B. „https://www…..“) ein
- Unter "Benutzerkennung" tragen Sie den in der Plugin-Konfiguration selbst vergebenen Benutzernamen ein ("API username", siehe oben bei "Vorbereitungen im TYPO3-Shop")
- Unter „Passwort" tragen Sie das ebenfalls im Plugin selbst vergebene Passwort ein ("API password", siehe oben bei "Vorbereitungen im TYPO3-Shop")
Klicken Sie nach Eingabe der Daten auf den blauen „Speichern“-Button.
2.) 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:
3.) Übertragen der Rechtstexte in den TYPO3-Shop
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: Per Schnittstelle wurden die Rechtstexte auf die jeweiligen TYPO3-Seiten übertragen. Die Aktualisierungs-Automatik überprüft und aktualisiert bei Bedarf die Rechtstexte in Ihrem TYPO3-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 TYPO3-Shop betrieben wird.
Dadurch ist direkt in der Schnittstellenverwaltung sichtbar, welche Schnittstelle zu welchem TYPO3-Shop gehört.
Interessierte Online-Händler können sich hier über unseren AGB-Service für TYPO3 informieren.
Tipp: Fragen zum Beitrag? Diskutieren Sie hierzu gerne mit uns in der Unternehmergruppe der IT-Recht Kanzlei auf Facebook .
Link kopieren
Als PDF exportieren
Per E-Mail verschicken
Zum Facebook-Account der Kanzlei
Zum Instagram-Account der Kanzlei
0 Kommentare