Integration Fields are still in beta and will be progressively deployed to all repositories. This feature allows you to connect your Prismic repository to an external API. If you don't already have Integration Fields in your repository, don't hesitate to ask for it in the chat support or slack community.
 

Introduction

We created the Integration Field to allow you to connect to your legacy systems, eCommerce CMSs, or custom APIs. This will allow your editorial/marketing team to choose an element from the external API, such as a product from your eCommerce catalog. This way you can use the power of Prismic to create rich content for your products.

Once you've connected your external API to your Prismic repository, you will be able to add a field to your documents where you can select an item from that catalog. The data for that item will then be available directly when you query your Prismic repository.

To set everything up, you just need to follow three simple steps: 

  1. Create your Integration Field and connect it to your external API
  2. Add the Integration Field to your custom type
  3. Begin selecting products from the editor 

 

Create & Manage your Integration Fields

You will find the Integration Field management page in the Settings of your repository. When you first arrive you will be able to create a new Integration Field for one of our native integrations (like Shopify or Magento) or for a custom API.

After adding at lease one integration, this screen will also list all your existing Integration Fields.

 

Add the Integration Field to your Custom Type

Any Integration Field that you create will automatically be available in the Custom Type builder. You will find your new fields at the bottom of the list of content fields and can add them directly to your types.

 

Select an Item in the Editor

Once added to your Custom Type, your editors will be able to search for and select a product from the catalog.

 

Automatic Content Updating

If a change is made in your external API, Prismic will automatically update the data to ensure that you always have the most up-to-date content.

The content refresh currently happens every 30 minutes, but this is likely to change in the future.
 

Next Steps

Now that you know the basics of Integration Fields, we invite you to learn more by viewing one of the following pages:

Connect to a Shopify catalog
Connect to a custom API
Add your Integration Field to a Custom Type
Selecting an Item in the editor

Did this answer your question?