Content Synchronization using the Whisk Studio Sync API

Learn how to set up a custom integration with Whisk Studio and synchronize your products and recipes.

When you don’t want to rely on any middleware app or platform for recipes and products synchronization and have the technical expertise or a connector to work with API and manage data flow, you can use our Studio Sync API to synchronize your content and manage the custom integration.

How to set up a Custom Integration with Whisk Studio?

To enable a smooth custom integration with Whisk Studio, you must follow the steps as described here.

We recommend you build a connector to sync data between Whisk Studio and your infrastructure.

If you have the resources, you can build the custom connector on your own; else, you can outsource it to a third-party if needed. We recommend you to acquire services from TrueLogic as it is one of our trusted vendors.

Whisk Studio Custom Integration Flow

To describe the integration process, we have split the information into two parts:

Products Synchronization

To start uploading products to Whisk Studio:

  1. Obtain an API key to authenticate API usage. For more information, see Request an API for Whisk Studio Integration.

  2. Configure your connector or ask your developers to use the Put Integration API endpoint to enable the Custom Integration by generating an Integration ID with type as INTEGRATION_TYPE_CUSTOM. If you already have the Custom Integration enabled, use the Get Integrations endpoint to retrieve the Integration ID.

  3. Next, use the Upsert Product Batch endpoint to start uploading products on Whisk Studio. The endpoint returns a list of Product IDs that you can use to update the products later.

Once you have your Products available on Whisk Studio, you can start using them as ingredients in your recipes and then move to set up Recipes Synchronization.

Recipes Synchronization

To start fetching recipes from the platform:

  1. Obtain an API key to authenticate API usage. For more information, see Request an API for Whisk Studio Integration.

  2. Configure your connector or ask your developers to use the Put Integration API endpoint to enable the Custom Integration by generating an Integration ID with type as INTEGRATION_TYPE_CUSTOM. If you already have the Custom Integration enabled, use the Get Integrations endpoint to retrieve the Integration ID.

  3. Next, use the Get Recipe Batch endpoint to start retrieving recipes’ data from Whisk Studio and save it in your database. Remember to save the Unix timestamp of each response and make it a practice to use it for filtering recipes using the updated_at.min parameter in your subsequent request to maintain a continuous flow of data retrieval without missing out on any recipes.

While using the updated_at.min parameter, remember to increase the Unix timestamp value by 1 to avoid any mix up. For example, if the Unix timestamp of your last response is1613403247000, in your subsequent request, you should specify the value of updated_at.min parameter as 1613403247001.

Now that your integration is enabled, you can configure your connector to request recipes ideally once every 5 minutes periodically.