Get Started

Installieren Sie das Clerk SDK in Ihrem DynamicWeb-Shop und richten Sie die Datensynchronisation ein. Diese Anleitung führt Sie durch den Installationsprozess und die Konfigurationsschritte.

Installation des SDK #

Daten-Sync einrichten #

Das SDK stellt die Werkzeuge zur Verfügung, um mit dem Aufbau von Indizes für Clerk zu beginnen. Sie sollten sicherstellen, dass die Indizes regelmäßig mit geplanten Aufgaben aufgebaut werden, damit Clerk stets aktuell bleibt. Wir empfehlen, sie mindestens einmal täglich zu aktualisieren.

Für die Synchronisierung der Daten zu Clerk.io muss eine REST API mit Zugriff auf die notwendigen Daten eingerichtet werden. (Produkte, Bestellungen, Kategorien, Seiten und Kunden).

Wir nutzen hierfür den Repositories-Bereich von DynamicWeb.

Die Dateien für die REST API sind im Clerk.io DynamicWeb SDK. enthalten.

1. Repository-Dateien aus dem Clerk.io SDK einfügen.

2. Privaten Schlüssel zur Konfigurationsdatei hinzufügen.

3. Repository-Index aufbauen.

4. Die REST API einrichten.

5. Den ersten Sync zu clerk.io ausführen.

Repository-Dateien einfügen #

In der Anleitung wird auf THEME_NAME verwiesen, dieser sollte durch den Namen des verwendeten Themes ersetzt werden, z.B. Rapido.

1. Navigieren Sie in DynamicWeb zu Files -> System -> Repositories und erstellen Sie einen neuen Unterordner namens Clerk.

2. Kopieren Sie alle Dateien aus dem Ordner Repositories im Clerk SDK in den neuen Ordner:

   • Products (Products.index & Products.query)
   • Categories (Categories.index & Categories.query)
   • Content (Content.index & Contents.query)
   • Customers (Customers.index & Customers.query)
   • Orders (Orders.index & Orders.query)

3. Navigieren Sie zu Files -> Templates -> Designs -> THEME_NAME -> QueryPublisher.

4. Laden Sie die folgenden Dateien aus dem Clerk SDK in QueryPublisher hoch:

   • ClerkProducts.cshtml
   • ClerkCategories.cshtml
   • ClerkContents.cshtml
   • ClerkCustomers.cshtml
   • ClerkOrders.cshtml

5. Navigieren Sie zu Files -> Templates -> Designs -> THEME_NAME.

6. Kopieren Sie die Dateien aus dem Ordner Rapido im Clerk SDK in den Ordner THEME_NAME:

   • ClerkConfig.cshtml
   • Json.cshtml

Privaten Schlüssel hinzufügen #

1. Navigieren Sie in my.clerk.io zu Developers -> API keys.

2. Kopieren Sie den Private API key.

3. Öffnen Sie in DynamicWeb die Datei ClerkConfig.cshtml, die Sie gerade hierher kopiert haben.

4. Ersetzen Sie "##### CLERK Private Key Here #####" durch den Private API key.

5. Speichern Sie die Änderungen und schließen Sie die Datei.

Repository-Index aufbauen #

1. Navigieren Sie zu Settings -> Repositories -> Clerk.

2. Klicken Sie auf den Products-Index.

3. Unter Builds -> Build, klicken Sie auf den Products-Button, um den Index zu erstellen.

4. Führen Sie das gleiche Verfahren für alle Indizes durch (Categories, Contents, Customers, Orders)

REST API einrichten #

1. Navigieren Sie zu Content im Seitenmenü und erstellen Sie einen neuen Ordner namens Clerk.

2. Legen Sie in diesem Ordner eine neue Seite an.

3. Klicken Sie auf Add Empty Page und wählen Sie dann Page als Typ.

4. Benennen Sie die Seite “Products” und setzen Sie den Seitenstatus auf Hide in menu.

5. Klicken Sie auf “New Paragraph” und scrollen Sie zu Add paragraph. Wählen Sie hier App.

6. Geben Sie ihr den Namen “Products”.

7. Wählen Sie App > Content > Query publisher

8. Unter Query wählen Sie Products.query.

9. Unter Template unten wählen Sie QueryPublisher/ClerkProducts.cshtml.

10. Klicken Sie oben auf der Seite auf Save.

11. Im linken Menü klicken Sie auf die 3 Punkte rechts von der Products-Seite und wählen Properties.

12. Unter URL setzen Sie Exact url for this page auf "/clerk/products".

13. Im oberen Menü deaktivieren Sie alle Optionen oberhalb von Accessibility.

14. Klicken Sie im oberen Menü auf Layout.

15. Wählen Sie im oberen Menü das Template Rapido: JSON

16. Speichern Sie die Seite erneut.

17. Wiederholen Sie diese Schritte für Contents, Orders, Categories und Customers und achten Sie darauf, products/Products jeweils durch den entsprechenden Datentyp zu ersetzen.

Ersten Sync ausführen #

1. Melden Sie sich in Ihrem my.clerk.io-Backend an.

2. Navigieren Sie zum Datenbereich.

3. Tragen Sie Ihre Webshop-Domain unter Store URL ein und fügen Sie Ihre Shop ID hinzu, um sicherzustellen, dass Clerk vom richtigen Katalog synchronisiert.

4. Wählen Sie alle zusätzlichen Sync-Optionen, die Sie möchten.

5. Klicken Sie auf Save.

6. Klicken Sie auf Start New Data Sync.

7. Warten Sie, bis der Sync abgeschlossen ist.