Bizzkit plugins

To integrate the CMS with Bizzkit products such as PIM, DAM, and Ecommerce Search, you need to install the Bizzkit plugins. See Plugins for more information.

Registering plugins

Plugins must be registered within a space in Builder.io before they are available to users. This can be done by navigating to the settings of the desired space and then, within the Integrations category, clicking "Edit" under Plugins:

Next, insert the URLs for each plugin you wish to include and save:

The URLs for the Bizzkit products are as follows:

1
2
3
4
5

https://{CompanyName}-content.bizzkit.cloud/plugins/dam-file.system.js
https://{CompanyName}-content.bizzkit.cloud/plugins/ecs-dynamic-products.system.js
https://{CompanyName}-content.bizzkit.cloud/plugins/ecs-products.system.js
https://{CompanyName}-content.bizzkit.cloud/plugins/pim-brand.system.js
https://{CompanyName}-content.bizzkit.cloud/plugins/pim-categories.system.js

Using plugins

The plugins offered by Bizzkit are of a type called "Editor plugin". This means they can be used as field types in Builder.io models:

When creating new content for your model, the custom field editor will display for entering data into the field:

Using plugins with custom components

Similar to data models, editor plugins can also be used as input types in custom components:

This ensures that users can only select values provided by the plugin integration, while offering an easy-to-use interface.

Reference

The plugins can be referenced by their respective type names and contain their own payload formats as described below. Note that only certain plugins can be used as targeting attributes.

DAM

• Type: Bizzkit DAM File
• Payload:

1
2
3
4
5

{
  "fileId": string,
  "croppingId": null | string,
  "filePath": string
}

• Targeting attribute: No

Ecommerce Search product

• Type: Bizzkit ECS Product
• Payload:

1
2
3
4

{
  "id": string,
  "segmentId": string
}

• Targeting attribute: No

Ecommerce Search product list

• Type: Bizzkit ECS Product List
• Payload:

1
2
3
4
5
6

[
  {
    "id": string,
    "segmentId": string
  }
]

• Targeting attribute: No

PIM brand

• Type: Bizzkit PIM Brand
• Payload:

1

string // The brand's system/unique name

• Targeting attribute: Yes

PIM product category

• Type: Bizzkit PIM Categories
• Payload:

1
2
3
4

{
  "id": string,
  "systemName": string
}

• Targeting attribute: No

PIM product category targeting

• Type: Bizzkit PIM Categories Targeting
• Payload:

1

string // The product category systemName

• Targeting attribute: Yes