With Builder's built-in plugins, you can integrate a third-party app or service with minimal configuration. For context on this topic, see Intro to Built-in Plugins.
To set up a built-in plugin in Builder:
- Go to Integrations.
- Click on the Enable button of the integration you'd like to use.
- When Builder completes the enabling process, click the Configure button in the notification that displays at the bottom of the screen. If you miss the notification, click the Settings button on the integration tile.
- Provide any API keys and tokens and click the Connect button.
The video below shows these steps with the Shopify plugin configuration, which is representative of most of the built-in plugins:
Depending on the third-party platform, you might need to configure developer/API access on your platform and set the correct permissions.
The exact steps and requirements for configuring e-commerce platforms vary from platform to platform. Refer to your platform's documentation for more information on how to acquire the API keys or tokens required by your plugin.
Tip: In this example, the Shopify plugin requires a Storefront access token and the Store domain, which you can find in the Shopify dashboard's Manage private apps section of your custom app.
You can use a starter kit as an alternative to installing a plugin and integrating it with your codebase.
Starter kits create a new Builder space with pre-configured models and content as well as a codebase that's already been integrated with a selected plugin and platform. You can add your own platform API credentials to the plugin settings to connect the content to your store.
Using a starter kit can be a convenient way to get started if you don't have a pre-existing codebase, or to play with the plugin without affecting your other spaces. You can also refer to the starter kit's code while reading through the plugin documentation as a reference implementation while creating your own.
The following starter kits are currently available:
To leverage plugins further, see the following documentation:
- Using e-commerce custom types with custom component inputs
- Targeting with plugins
- Setting up e-commerce resource previews
The features described in the articles above make use of custom types introduced by e-commerce plugins. Refer to E-commerce custom types for in-depth information.
