AGB HOSTING-SERVICE EINBINDUNG (Version 3)

Transkript

1 AGB HOSTING-SERVICE EINBINDUNG (Version 3) Mit dieser Schnittstellen-Beschreibung zum AGB HOSTING-SERVICE der janolaw AG können die auf der janolaw Website erzeugten juristischen Dokumente in jedem beliebigen Shopsystem verwendet werden. Datei-Namen Wir bieten folgende Dateien zum Einbinden in das Shopsystem an: AGB: Impressum: Widerrufsbelehrung: Datenschutzerklärung: Muster-Widerrufsformular: terms legaldetails revocation datasecurity model-withdrawal-form NEU!!! Datei-Typen _include.html Bei den Include Dateien handelt es sich um HTML-Snippets, die nur den eigentlichen Body der Datei zwischen zwei DIV-Tags (<div class="janolaw-body">...</div) enthalten, jedoch keine komplette HTML-Struktur. Die Include-Dateien enthalten zudem keine Überschrift, da diese i.d.r. von den Shopsystemen zur Verfügung gestellt wird..html Sollten Dateien mit einer kompletten HTML-Struktur und einer Überschrift gewünscht werden, so können die oben genannten Dateinamen ohne _include verwendet werden (z.b. terms.html).txt Für die Einbindung der oben genannten Inhalte in eine (z.b. Widerrufsbelehrung, Muster- Widerrufsformular, AGB), bieten wir diese auch als Text-Dokumente (ohne eine HTML-Struktur) an. Diese Text-Dokumente haben dann das Suffix.txt, also z.b. revocation.txt..pdf NEU!!! Alternativ können die Texte auch als Anhang in die Auftragsbestätigung eingebunden werden. (z.b. Widerrufsbelehrung, Muster-Widerrufsformular, AGB) bzw. zusätzlich auf den Webseiten. 1

2 Formatierung und CSS Klassen Derzeit verwenden wir folgende DIV-Tags, die Sie sich entsprechend (per CSS) konfigurieren können. Wenn Sie den Style ändern wollen, ist es nötig, dass Sie die zur Verfügung gestellte CSS-Datei auf Ihrem Server ablegen um sie dort zu modifizieren (Die standardmäßig zur Verfügung gestellte CSS- Datei können Sie hier herunterladen): janolaw-footer: für die Fußzeile unseres Dokumentes; hierin befindet sich ein Link auf unsere Seite. janolaw-paragraph: Bezeichnet einen eigenen Paragrafen. Innerhalb dieser Dokumentklassen werden entsprechende Untertags (meist <b> und <br>, aber auch <ul> und <li>) verwendet. Pfad zu den Dokumenten Weiterhin wird noch der Sprachcode für das Land, für das die Dokumente angezeigt werden sollen, benötigt. Wir nutzen hier den ISO Länder-Code der einzelnen Länder, also z.b. DE für Deutschland, GB für England und FR für Frankreich (siehe dazu auch Mit diesen Daten können Sie dann die URL zu den entsprechenden Dokumenten (AGB etc.) aufbauen: Um die Seiten aufrufen zu können, benötigen Sie zwei IDs, die auf unserem System zur Identifikation genutzt werden. Das sind zum einen die Kundennummer (USER-ID) und zum anderen die Shopnummer (SHOP-ID). Diese beiden IDs bekommt der Kunde nach dem Kauf des AGB HOSTING- SERVICE mitgeteilt. NAME>>/<DATEI-FORMAT> 2

3 Schnittstellen Versionen Die bisherigen Schnittstellen Versionen des AGB Hosting-Service im Vergleich: Neu ab Version 3 Version 1 Version 2 Version 3 Datei-Namen Impressum impressum legaldetails legaldetails AGB agb terms terms Widerrufsbelehrung widerrufsbelehrung revocation revocation Datenschutzerklärun g datenschutzerklaerung datasecurity datasecurity Muster- Widerrufsformular - - model-withdrawal-form Datei-Typen.html.html.html _include.html _include.html _include.html.txt.txt.txt - -.pdf Pfad für Speicherung service/shops/<user- ID>/<SHOP-ID>/<DATEI- NAME>>/<DATEI- FORMAT> service/shops/<user- ID>/<SHOP- ID>/<LÄNDERCODE>/<D ATEI-NAME>>/<DATEI- FORMAT> service/shops/<user- ID>/<SHOP- ID>/<LÄNDERCODE>/<D ATEI-NAME>>/<DATEI- FORMAT> Länderordner ISO angebotene Sprachversionen Nein Ja Ja deutsch deutsch deutsch - - englisch - - französisch Tester Kennungen USER-ID: SHOP-ID: USER-ID: SHOP-ID: USER-ID: SHOP-ID:

4 Versionsprüfung Für die Versionsüberprüfung empfiehlt es sich folgende Prüfroutine zu entwickeln: 1. Schritt) Prüfung ob es das Dokument model-withdrawal-form gibt Wenn ja, dann handelt es sich um Version 3 2. Schritt) Wenn nein, dann Prüfung ob es weitere Dokumente mit englischer Bezeichnung gibt Wenn ja, dann handelt es sich um Version 2 Wenn nein, dann handelt es sich um Version 1 Wenn es sich um die alten Versionen 1 oder 2 handelt, dann dürfen die Optionen für die PDF Einbindung bzw. Mehrsprachigkeit nicht angezeigt werden. Ein Hinweistext den Service neu zu generieren bzw. die mehrsprachige Version zu erwerben sollte hinterlegt und angezeigt werden. Bitte prüfen Sie, ob Sie die Texte neu generiert haben und für die optionale mehrsprachige Version den Service bei janolaw gebucht haben. Kontaktieren Sie dazu janolaw unter support@janolaw.de oder unter / Alternativ kann im Rahmen der Versionsprüfung aber auch geprüft werden ob in den jeweiligen.html bzw. _include.html Dateien ein Meta Tag Version3 enthalten ist. Beispielhaft ein Screenshot für die englischen Version 4

5 Synchronisation Die oben genannten Dateien sollten regelmäßig mit einer Zeitspanne von zwei bis maximal acht Stunden automatisch synchronisiert und auf dem Shopsystem gecacht werden. Es empfiehlt sich, den Kunden zusätzlich eine manuelle Synchronisierung anzubieten bzw. die Option das Aktualisierungsintervall selbst zu definieren. Die Inhalte der Dateien sind grundsätzlich im Shopsystem an der entsprechenden Stelle so einzubinden, dass sie nicht nur auf der Webseite sondern in allen relevanten Prozessen (z.b. Widerrufsbelehrung, Muster-Widerrufsformular, AGB in der zur Bestellbestätigung) zur Verfügung stehen. Sollte die Synchronisation, d.h. der Datei-Download, nicht fehlerfrei ausgeführt werden können, dann sind auch weiterhin die entsprechend gecachten Inhalte zu nutzen und im Shopsystem anzuzeigen. Usability / Einbindung der Dokumente Auftragsbestätigung Den Shopbetreibern sollte eine Auswahloption zur Verfügung gestellt werden, welche Sprachen genutzt werden sollen. Ebenso sollte dem Administrator die Option angeboten werden, dass die 3 Dokumente (Widerrufsbelehrung, Muster-Widerrufsformular, AGB) in den Kontext der eingebunden werden können oder dass die Rechtstexte mittels PDF Anhang eingebunden werden können. Wenn die PDF Dokumente als Anhang in der Auftragsbestätigung verwendet werden sollen, dann müssen diese mit dem jeweiligen Ländernamen im Shopsystem abgespeichert werden, da sonst nur die englische Bezeichnung der Dokumente standardmäßig zur Verfügung steht. Dokumenten- Bezeichnung Länderordner Deutsch Englisch Französisch legaldetails Impressum Imprint Mentions légales terms AGB General Terms and Conditions Conditions Générales de Vente revocation Widerrufsbelehrung Instructions on withdrawal Informations standardisées sur la rétractation datasecurity Datenschutzerklärung Data privacy policy Déclaration quant à la protection des données model-withdrawal-form Muster-Widerrufsformular Model withdrawal form Modèle de formulaire de rétractation 5

6 Webseiten Optional sollte dem Shopbetreiber angeboten werden, dass er die Rechtstexte zusätzlich als PDF auf die jeweiligen Webseiten bzw. in den Warenkorbprozess einbinden kann. Für diese Optionen sollte eine Versionsprüfung (vgl. S. 4) erfolgen. Sind keine PDF Dokumente verfügbar (Version 1 und 2), dann sollten die oben beschriebenen Auswahlfelder bzw. Optionen nicht angeboten bzw. grau hinterlegt werden und ein Hinweistext den Service neu zu generieren bzw. die mehrsprachige Version bei janolaw zu erwerben angezeigt werden. 6

7 Deutschsprachige Texte Für einen Shop mit Deutscher Sprache sähen die Dokumenten-Pfade wie folgt aus: Impressum NEU!!! AGB NEU!!! Widerrufsbelehrung NEU!!! Datenschutzerklärung NEU!!! Muster-Widerrufsformular KOMLETT NEU!!!

8 Englischsprachige Texte KOMLETT NEU!!! Für einen Shop mit Englischer Sprache sähen die Dokumenten-Pfade wie folgt aus: Impressum AGB Widerrufsbelehrung Datenschutzerklärung Muster-Widerrufsformular

9 Französischsprachige Texte KOMPLETT NEU!!! Für einen Shop mit Französischer Sprache sähen die Dokumenten-Pfade wie folgt aus: Impressum AGB Widerrufsbelehrung Datenschutzerklärung Muster-Widerrufsformular

10 Kompatibilität mit alten Schnittstellen (Version 1) In einer Übergangszeit wird die Default-Sprache (meist: de) in das bisherige Verzeichnis mit den bisherigen Dokumentnamen kopiert, so dass auch ältere Plugins funktionieren. Hier sieht dann die URL wie folgt aus: FORMAT> Datei-Namen Bei Verwendung der Version 1 beschränkt sich das Datei-Angebot auf folgende Dokumente: AGB: Impressum: Widerrufsbelehrung: Datenschutzerklärung: agb impressum widerrufsbelehrung datenschutzerklaerung Datei-Typen Bei Verwendung der Version 1 werden nur folgende Datei-Typen angeboten: _include.html Bei den Include Dateien handelt es sich um HTML-Snippets, die nur den eigentlichen Body der Datei zwischen zwei DIV-Tags (<div class="janolaw-body">...</div) enthalten, jedoch keine komplette HTML-Struktur. Die Include-Dateien enthalten zudem keine Überschrift, da diese i.d.r. von den Shopsystemen zur Verfügung gestellt wird..html Sollten Dateien mit einer kompletten HTML-Struktur und einer Überschrift gewünscht werden, so können die oben genannten Dateinamen ohne _include verwendet werden (z.b. agb.html).txt Für die Einbindung der oben genannten Inhalte in eine (z.b. Widerrufsbelehrung), bieten wir diese auch als Text-Dokumente (ohne eine HTML-Struktur) an. Diese Text-Dokumente haben dann das Suffix.txt, also z.b. agb.txt. 10

11 Pfad zu den Dokumenten Beispielhaft sieht das bei Verwendung der Version 1 wie folgt aus: Impressum AGB Widerrufsbelehrung Datenschutzerklärung

12 Überblick über schon bestehende Schnittstellen 12