huluvu21 / kontent-custom-element-crystallize

Crystallize product selector for Kentico Kontent

Crystallize product selector for Kentico Kontent

This repository contains source code of Crystallize product selector custom element for Kentico Kontent.

Setup

1. Create your account in the Crystallize service.
2. Deploy the code to a secure public host.
   • See the deploying section for a really quick option.
3. Follow the instructions in the Kentico Kontent documentation to add the element to a content model.
   • The Hosted code URL is where you deployed to in step 1.
   • Configure the JSON parameters as detailed in the JSON Parameters section.

JSON Parameters

You will also need to provide the following JSON parameters for the custom element to connect to your Crystallize account. Replace the placeholder with the actual value from the Crystallize UI:

{
    "tenantId": "<TENANT ID>",
    "disableModificationOfExternalItems": true
}

The disableModificationOfExternalItems parameter is optional and allows for a different behavior for items created by a possible integration that creates an item in Kontent when a product is created in Crystallize. The value of the custom element contains an isExternal property in that case. If the isExternal is set to true, the selector is shown in a mode that doesn't allow for a further change of its value.

Example of the output in the Delivery Response

The value in Delivery API is going to have the following shape:

{
    "id": "5faa875de8f6e2433cf877c5",
    "name": "Sweet Existence",
    "sku": "your-sku-1605011292891",
    "image": "https://media.crystallize.com/kentico-kontent/20/11/10/2/ebbdae2cb9029da541577e49cc234725f57ae5ef.jpg"
}

Deploying

Netlify has made this easy. If you click the deploy button below, it will guide you through the process of deploying it to Netlify and leave you with a copy of the repository in your GitHub account as well.