Get Started

Instala el SDK de Clerk en tu tienda DynamicWeb y configura la sincronización de datos. Esta guía te lleva paso a paso por el proceso de instalación y configuración.

Instalando el SDK #

Configurar sincronización de datos #

El SDK te proporciona las herramientas necesarias para comenzar a construir índices para Clerk. Debes asegurarte de construir los índices regularmente con tareas programadas para que Clerk esté siempre actualizado. Recomendamos actualizarlos al menos una vez al día.

Para la sincronización de datos a Clerk.io, debemos configurar una REST API con acceso a los datos necesarios. (Productos, Pedidos, Categorías, Páginas y Clientes).

Usaremos la parte de Repositories de DynamicWeb para acceder a esto.

Los archivos para la REST API están incluidos en el Clerk.io DynamicWeb SDK.

1. Inserta los archivos Repository del SDK de Clerk.io.

2. Añade la clave privada al archivo de configuración.

3. Construye el índice de Repository.

4. Configura la REST API.

5. Ejecuta tu primera sincronización con clerk.io.

Insertar archivos de repository #

En la guía, haremos referencia a THEME_NAME que debe ser reemplazado por el nombre del tema utilizado, por ejemplo, Rapido.

1. En DynamicWeb, navega a Files -> System -> Repositories y crea una subcarpeta llamada Clerk.

2. Copia todos los archivos de la carpeta Repositories en el Clerk SDK a la nueva carpeta:

   • 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. Navega a Files -> Templates -> Designs -> THEME_NAME -> QueryPublisher.

4. Sube los siguientes archivos del Clerk SDK a QueryPublisher:

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

5. Navega a Files -> Templates -> Designs -> THEME_NAME.

6. Copia los archivos de la carpeta Rapido en el Clerk SDK a la carpeta THEME_NAME:

   • ClerkConfig.cshtml
   • Json.cshtml

Añadir clave privada #

1. En my.clerk.io, navega a Developers -> API keys.

2. Copia la Private API key.

3. En DynamicWeb, abre ClerkConfig.cshtml que acabas de copiar aquí.

4. Sustituye "##### CLERK Private Key Here #####" por la Private API key.

5. Guarda los cambios y cierra.

Construir el índice de repository #

1. Navega a Settings -> Repositories -> Clerk.

2. Haz clic en el índice Products

3. Bajo Builds -> Build, haz clic en el botón Products para construir el índice.

4. Sigue el mismo procedimiento para todos los índices (Categories, Contents, Customers, Orders)

Configurar REST API #

1. Navega a Content en el menú lateral y crea una nueva carpeta llamada Clerk.

2. Dentro de esta carpeta, crea una nueva página

3. Haz clic en Add Empty Page y luego elige Page como tipo.

4. Nombra la página “Products” y establece el Estado de la Página en Hide in menu

5. Haz clic en “New Paragraph” y desplázate hasta Add paragraph. Desde aquí, elige App.

6. Dale el nombre “Products”.

7. Elige App > Content > Query publisher

8. Bajo Query, elige Products.query.

9. En Template en la parte inferior, elige QueryPublisher/ClerkProducts.cshtml.

10. En la parte superior de la página, haz clic en Save.

11. En el menú de la izquierda, haz clic en los 3 puntos a la derecha de la página Products y haz clic en Properties.

12. En URL, establece Exact url for this page en "/clerk/products".

13. En el menú superior, desmarca todas las opciones sobre Accessibility.

14. Haz clic en Layout en el menú superior.

15. En el menú superior, selecciona la plantilla Rapido: JSON

16. Guarda la página de nuevo.

17. Repite estos pasos para Contents, Orders, Categories y Customers, asegurándote de sustituir products/Products por el tipo de dato correspondiente en todo momento.

Ejecutar la primera sincronización #

1. Inicia sesión en el backend de my.clerk.io.

2. Navega a la sección de Data.

3. Inserta el dominio de tu tienda online bajo Store URL y añade tu Shop ID para asegurarte de que Clerk sincroniza desde el catálogo correcto.

4. Elige cualquier opción adicional de sincronización que desees.

5. Haz clic en Save.

6. Haz clic en Start New Data Sync.

7. Espera a que termine la sincronización.