Get Started

Installa il Clerk SDK sul tuo negozio DynamicWeb e configura la sincronizzazione dei dati. Questa guida ti accompagna attraverso il processo di installazione e i passaggi di configurazione.

Installazione dell’SDK #

Configurazione della sincronizzazione dati #

L’SDK ti fornisce gli strumenti per iniziare a costruire gli indici per Clerk. Assicurati di costruire gli indici regolarmente tramite task pianificati così che Clerk rimanga aggiornato. Consigliamo di aggiornarli almeno una volta al giorno.

Per la sincronizzazione dei dati su Clerk.io, è necessario configurare una REST API con accesso ai dati necessari (Prodotti, Ordini, Categorie, Pagine e Clienti).

Utilizzeremo la sezione Repositories di DynamicWeb per accedere a questi dati.

I file per la REST API sono inclusi nel Clerk.io DynamicWeb SDK.

1. Inserisci i file Repository dal Clerk.io SDK.

2. Aggiungi la chiave privata al file di configurazione.

3. Costruisci l’indice Repository.

4. Configura la REST API.

5. Esegui la tua prima sincronizzazione su clerk.io.

Inserisci i file repository #

Nella guida, faremo riferimento a THEME_NAME che dovrà essere sostituito dal nome del Tema utilizzato, es. Rapido.

1. In DynamicWeb vai su File -> Sistema -> Repositories e crea una nuova sottocartella chiamata Clerk.

2. Copia tutti i file dalla cartella Repositories nel Clerk SDK nella nuova cartella:

   • 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. Vai su File -> Templates -> Designs -> THEME_NAME -> QueryPublisher.

4. Carica i seguenti file dal Clerk SDK in QueryPublisher:

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

5. Vai su File -> Templates -> Designs -> THEME_NAME.

6. Copia i file dalla cartella Rapido nel Clerk SDK nella cartella THEME_NAME:

   • ClerkConfig.cshtml
   • Json.cshtml

Aggiungi la chiave privata #

1. In my.clerk.io, vai su Developers -> API keys.

2. Copia la Private API key.

3. In DynamicWeb, apri ClerkConfig.cshtml che hai appena copiato qui.

4. Sostituisci "##### CLERK Private Key Here #####" con la Private API key.

5. Salva le modifiche e chiudi.

Costruisci l’indice repository #

1. Vai su Impostazioni -> Repositories -> Clerk.

2. Clicca sull’indice Products

3. In Builds -> Build, clicca sul pulsante Products per costruire l’indice.

4. Segui la stessa procedura per tutti gli indici (Categories, Contents, Customers, Orders)

Configura la REST API #

1. Naviga su Content nel menu laterale e crea una nuova cartella chiamata Clerk.

2. All’interno di questa cartella, crea una nuova pagina

3. Clicca Add Empty Page e poi scegli Page come tipo.

4. Dai alla pagina il nome “Products”, e imposta lo Stato Pagina su Nascondi nel menu

5. Clicca su “New Paragraph” e scorri fino a Add paragraph. Da qui, scegli App.

6. Assegnale il nome “Products”.

7. Scegli App > Content > Query publisher

8. Sotto Query, scegli Products.query.

9. In Template in basso, scegli QueryPublisher/ClerkProducts.cshtml.

10. Nella parte superiore della pagina, clicca su Salva.

11. Nel menu a sinistra, clicca sui 3 puntini a destra della pagina Products, e clicca su Proprietà.

12. In URL, imposta URL esatta per questa pagina su "/clerk/products".

13. Nel menu in alto, deseleziona tutte le opzioni sopra Accessibilità.

14. Clicca su Layout nel menu superiore.

15. Nel menu in alto, scegli il template Rapido: JSON

16. Salva di nuovo la pagina.

17. Ripeti questi passaggi per Contents, Orders, Categories e Customers, assicurandoti di sostituire products/Products con il tipo di dato rilevante per ogni sezione.

Esegui la prima sincronizzazione #

1. Accedi al backend di my.clerk.io.

2. Vai alla sezione Data.

3. Inserisci il dominio del tuo webshop sotto Store URL e aggiungi il tuo Shop ID per assicurarti che Clerk sincronizzi dal catalogo corretto.

4. Scegli eventuali opzioni di sincronizzazione aggiuntive desiderate.

5. Clicca su Salva.

6. Clicca su Start New Data Sync.

7. Attendi che la sincronizzazione sia completata.