Get Started

SDK installieren #

Daten-Synchronisation einrichten #

Das SDK gibt Ihnen die Werkzeuge, um mit dem Erstellen von Indizes für Clerk zu beginnen. Sie sollten sicherstellen, dass die Indizes regelmäßig mit geplanten Aufgaben erstellt werden, damit Clerk auf dem neuesten Stand bleibt. Wir empfehlen, sie mindestens einmal am Tag zu aktualisieren.

Für die Synchronisation von Daten zu Clerk.io müssen wir eine REST API einrichten, mit Zugriff auf die notwendigen Daten. (Produkte, Bestellungen, Kategorien, Seiten und Kunden).

Wir werden den Repositories-Teil von DynamicWeb für den Zugriff darauf verwenden.

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

1. Fügen Sie die Repository-Dateien aus dem Clerk.io SDK ein.

2. Fügen Sie den privaten Schlüssel zur Konfigurationsdatei hinzu.

3. Erstellen Sie den Repository-Index.

4. Richten Sie die REST API ein.

5. Führen Sie Ihre erste Synchronisation zu clerk.io durch.

Repository-Dateien aus dem Clerk SDK einfügen #

In der Anleitung werden wir auf THEME_NAME verweisen, das durch den Namen des verwendeten Themas ersetzt werden sollte, z.B. Rapido.

1. Navigieren Sie in DynamicWeb zu Dateien -> System -> Repositories und erstellen Sie einen neuen Unterordner mit dem Namen Clerk.

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

3. Produkte (Products.index & Products.query)

4. Kategorien (Categories.index & Categories.query)

5. Inhalt (Content.index & Contents.query)

6. Kunden (Customers.index & Customers.query)

7. Bestellungen (Orders.index & Orders.query)

8. Navigieren Sie zu Dateien -> Vorlagen -> Designs -> THEME_NAME -> QueryPublisher.

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

10. ClerkProducts.cshtml

11. ClerkCategories.cshtml

12. ClerkContents.cshtml

13. ClerkCustomers.cshtml

14. ClerkOrders.cshtml

15. Navigieren Sie zu Dateien -> Vorlagen -> Designs -> THEME_NAME.

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

17. ClerkConfig.cshtml

18. Json.cshtml

Privaten Schlüssel zur Konfigurationsdatei hinzufügen #

1. Navigieren Sie in my.clerk.io zu Einstellungen -> API-Schlüssel.

2. Kopieren Sie den Privaten API-Schlüssel.

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

4. Ersetzen Sie "##### CLERK Private Key Here #####" durch den Privaten API-Schlüssel.

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

Repository-Index erstellen #

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

2. Klicken Sie auf den Produkte-Index.

3. Klicken Sie unter Builds -> Build auf die Schaltfläche Produkte, um den Index zu erstellen.

4. Befolgen Sie dasselbe Verfahren für alle Indizes (Kategorien, Inhalte, Kunden, Bestellungen).

Die REST API einrichten #

1. Navigieren Sie im Seitenmenü zu Inhalt und erstellen Sie einen neuen Ordner mit dem Namen Clerk.

2. Erstellen Sie in diesem Ordner eine neue Seite.

3. Klicken Sie auf Leere Seite hinzufügen und wählen Sie dann Seite als Typ aus.

4. Benennen Sie die Seite “Produkte” und setzen Sie den Seitenstatus auf Im Menü ausblenden.

5. Klicken Sie auf „Neuen Absatz“ und scrollen Sie zu Absatz hinzufügen. Wählen Sie von hier App.

6. Geben Sie ihr den Namen “Produkte”.

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

8. Wählen Sie unter Abfrage Products.query.

9. Wählen Sie unter Vorlage unten QueryPublisher/ClerkProducts.cshtml.

10. Klicken Sie oben auf der Seite auf Speichern.

11. Klicken Sie im linken Menü auf die 3 Punkte rechts von der Produkte-Seite und klicken Sie auf Eigenschaften.

12. Setzen Sie unter URL die Exakte URL für diese Seite auf “/clerk/products”.

13. Deaktivieren Sie im oberen Menü alle Optionen über der Barrierefreiheit.

14. Klicken Sie im oberen Menü auf Layout.

15. Wählen Sie im oberen Menü die Vorlage Rapido: JSON.

16. Speichern Sie die Seite erneut.

17. Wiederholen Sie diese Schritte für Inhalte, Bestellungen, Kategorien und Kunden, und stellen Sie sicher, dass Sie products/Products durch den entsprechenden Datentyp ersetzen.

Führen Sie Ihre erste Synchronisation zu clerk.io durch #

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

2. Navigieren Sie zum Abschnitt Daten.

3. Geben Sie die Domain Ihres Webshops unter Store URL ein und fügen Sie Ihre Shop ID hinzu, um sicherzustellen, dass Clerk aus dem richtigen Katalog synchronisiert.

4. Wählen Sie alle zusätzlichen Synchronisationsoptionen, die Sie möchten.

5. Klicken Sie auf Speichern.

6. Klicken Sie auf Neue Daten-Synchronisation starten.

7. Warten Sie, bis die Synchronisation abgeschlossen ist.