Get Started

Instalación del SDK #

Configuración de la sincronización de datos #

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

Para la sincronización de datos con Clerk.io, tenemos que configurar una API REST, 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 API REST están incluidos en el Clerk.io DynamicWeb SDK.

1. Inserta los archivos del Repositorio desde el SDK de Clerk.io.

2. Agrega la clave privada al archivo de configuración.

3. Construye el Índice del Repositorio.

4. Configura la API REST.

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

Inserta los archivos del Repositorio desde el SDK de Clerk #

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 nueva subcarpeta llamada Clerk.

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

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

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

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

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

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

8. Navega a Files -> Templates -> Designs -> THEME_NAME -> QueryPublisher.

9. Sube los siguientes archivos del SDK de Clerk a QueryPublisher:

10. ClerkProducts.cshtml

11. ClerkCategories.cshtml

12. ClerkContents.cshtml

13. ClerkCustomers.cshtml

14. ClerkOrders.cshtml

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

16. Copia los archivos de la carpeta Rapido en el SDK de Clerk dentro de la carpeta THEME_NAME:

17. ClerkConfig.cshtml

18. Json.cshtml

Agrega la Clave Privada al archivo de configuración #

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

2. Copia la Clave API Privada.

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

4. Reemplaza "##### CLERK Private Key Here #####" con la Clave API Privada.

5. Guarda los cambios y cierra.

Construye el Índice del Repositorio #

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

2. Haz clic en el índice Products

3. En Builds -> Build, haz clic en el botón de Productos para construir el índice.

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

Configura la API REST #

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 a Add paragraph. Desde aquí, elige App.

6. Dale el nombre “Products”.

7. Elige App > Content > Query publisher

8. En 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ú izquierdo, 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 la Accessibility.

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

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

16. Guarda la página nuevamente.

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

Ejecuta tu primera sincronización a clerk.io #

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

2. Navega a la sección de Datos.

3. Inserta el dominio de tu tienda en Store URL y agrega tu Shop ID para asegurarte de que Clerk sincronice desde el catálogo correcto.

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

5. Haz clic en Guardar.

6. Haz clic en Iniciar Nueva Sincronización de Datos.

7. Espera a que la sincronización termine.