Dynamicweb

Get Started

Install and configure the Clerk SDK on DynamicWeb

Install the Clerk SDK on your DynamicWeb store. This guide walks you through the installation process.

The Clerk SDK for DynamicWeb is a software development kit, which means you’ll need to make some changes in the code to match your webshop. The SDK provides the files needed to get started with synchronizing your catalog with Clerk.io.

Download the SDK #

  1. Go to the Clerk DynamicWeb GitHub repository.

  2. Under Code, download the zip file containing all the SDK files.

  3. Unpack the zip file. You’ll see folders for Repositories, QueryPublisher, and your theme (e.g., Rapido or Swift).

Add repository files #

  1. In DynamicWeb, go to Files > System > Repositories.

  2. Click the three dots (⋯) and choose New subfolder.

  3. Name the folder Clerk.

  4. Copy all files from the Repositories folder in the SDK to the new Clerk folder in DynamicWeb:

    • 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)

Add QueryPublisher files #

  1. In DynamicWeb, go to Files > Templates > Designs > [THEME_NAME] > QueryPublisher.

    Replace [THEME_NAME] with your theme name (e.g., Swift, Rapido, or another theme name).

  2. Copy all files from the QueryPublisher folder in the SDK to the QueryPublisher folder in DynamicWeb:

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

Add theme files #

  1. In DynamicWeb, go to Files > Templates > Designs > [THEME_NAME].

  2. Copy the following files from the theme folder in the SDK (e.g., Rapido or Swift) to your theme folder:

    • ClerkConfig.cshtml
    • Json.cshtml

Configure private key #

  1. In my.clerk.io, go to Settings > API Keys.

  2. Copy your Private API Key.

  3. In DynamicWeb, open the ClerkConfig.cshtml file you just copied.

  4. Find the placeholder text "##### CLERK Private Key Here #####" and replace it with your Private API Key.

    This allows authorization when requesting data from DynamicWeb. Clerk will always send this private key in API calls.

  5. Save the file.

Sync data #

Syncing data connects your DynamicWeb store to Clerk, allowing Clerk to access your products, orders, customers, categories, and content. This enables Clerk to provide personalized recommendations and search results based on your actual store data. Follow the steps in the Sync Data guide to set up the data sync.