Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v2.0.0
v2.0.0
  • The Whisk Platform
  • Whisk API Overview
    • Introduction
    • Integration
    • Authentication
      • Server Token
      • User Access Token
        • Auth Flow Example
      • Client Token
      • Anonymous Access from Client Apps
    • Whisk Sandbox
    • Getting Started
  • Whisk API Reference 2.0
    • Provisioning
      • Get provisioning
    • Autocomplete
    • Community
      • Get your Communities
      • Get Communities from a Topic
      • Discover Recommended Communities
      • Search Communities
      • Get a Community
      • Get Recipes from a Community
      • Add Recipes to a Community
      • Remove a Recipe from a Community
      • Join a Community
      • Leave a Community
    • Posts and Reviews
      • Get reviews for a recipe
      • Create or edit review
      • Create a Post
      • Get Post by id
      • Delete a Post
      • Edit a Post
      • Report a Post
      • Create a Post Reply
      • Get Post Replies
      • Delete a Post reply
      • Report a Post reply
      • Like a Post or Reply
      • Users who liked a Post or Reply
    • Public profiles
      • Hide recipe in Public profile
      • Get Recipes for Public Profile
      • Get User's public profile by user_id
      • Get User's public profile by username
    • Custom Label
    • Feed
      • Obtain a Recipe Feed
    • Food DB
      • Autocomplete
      • Search
      • Get Food
    • Food List
    • Food Log
    • Foodpairing
    • Healthy meal recommendations
      • Healthy recipe only recommendations for DA
      • Recipe recommendations for SH
      • Tailored Plan API request for Samsung TV
    • Meal Plan
      • Generate a Meal Plan
      • Meal Object
        • Get Meals
        • Delete Meal
        • Add a Meal
      • Meal Plan Settings Object
        • Get Meal Plan Settings
        • Update Meal Plan Settings
      • Meal Plan Batch
    • Recipe
      • Get a Recipe
      • Search a Recipe
      • User Recipes & Collections
        • Add User Recipe
        • Create A Recipe
        • Update External Recipe
        • Get All User Recipes
        • Update User Recipe
        • Remove Recipe from Favorites
        • Create Collection
        • Get All User Collections
        • Get Collection
        • Get Recipes from a Collection
        • Remove Collection
        • Get Smart Collection
        • Get Recipes from a Smart Collection
    • Shopping List
      • Get your Shopping Lists
      • Get a Shopping List
      • Create a Shopping List
      • Delete a Shopping List
      • Update basic details of a Shopping List
      • Move Items between Shopping Lists
      • Add Items to a Shopping List
      • Delete an Item from a Shopping List
      • Update an Item in a Shopping List
      • Clear Items from a Shopping List
    • Media
    • Store Item
    • Unit Conversion
    • Users
      • Get a User
      • Update User Settings using Patch
      • Update User Settings using Post
    • Try it out!
  • Shopping List SDK
    • Overview
    • Examples
      • Shoppable Recipes
      • Shoppable Products
      • Shoppable Media
    • Basic Setup
      • Basic Setup
      • Methods
      • Event Listeners
      • Widget
      • Subscriptions
      • Global Configuration
      • UTM Parameters
      • Using With SPA
  • Shopping List Mobile API
    • Overview
    • Examples
    • Reference
  • API Resources
    • Authentication Scopes
    • Errors and Troubleshooting
    • Cursor Pagination
    • Limits
    • Nutrients
    • Recipe Labels
    • Filtering Recipes using Custom Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Integrated Retailers
    • Optimizing Image Load
    • Meal Plan
Powered by GitBook
On this page
  • Supported Integration Methods
  • Server-Side Integration
  • Client-Side Integration
  • Integration Process
  • Partners API Integration Sample

Was this helpful?

  1. Whisk API Overview

Integration

Learn how to integrate with the Whisk.

PreviousIntroductionNextAuthentication

Last updated 4 years ago

Was this helpful?

You can integrate with Whisk using our API to build an app or a website related to shoppable recipe content.

Here are the following advantages of using our API:

  • There is no need to store recipe content in your infrastructure.

  • You can provide your users with visual delight and smarter personalized experiences.

  • You can let your users closely connect with the Whisk ecosystem.

  • Your app or a website can have a flexible set of functionalities and look and feel.

The Whisk API lets you use some of our pre-designed functionalities based on your content like recipe search, recipe feed, meal planning, shopping list, etc. You can find the full list of APIs .

Supported Integration Methods

You can integrate with Whisk API on either server-side or client-side based on your requirements.

Server-Side Integration

The Server-Side Integration Flow

Client-Side Integration

Integration Process

To get started with Whisk’s Partners API integration is simple. 1. Get a Sandbox API key. For more information, see Obtain an API key.

4. When you are ready to integrate, request production API access and start building your app or a website. For more information, see Obtain an API key.

Partners API Integration Sample

Whisk Playground is a live demo application that you can refer to see how integration with Whisk looks.

URL: https://showcase.whisk.com/

This demo showcases just a basic layout and a few general functionalities. We provide more functionalities through our API, which you can use to improve the user experience of your application or website.

If you want your users to have a personalized and responsive experience, we generally recommend you to have a server layer between Whisk’s Partners API and your client application. This layer allows you to have your user session mechanism with your client application. We also recommend having a cache on your server-side for non-personalized requests to avoid exceeding API limits. To have this integration done, you can use and for API authentication.

The Client-Side Integration Flow

The client-side integration lets you directly integrate your client application with Whisk but have limited access. For this integration type, you can use the for API authentication to call read-only API endpoints like Get Recipe or . While you choose this integration type, you should know that you can exceed the API limits with excessive usage, and it may result in your client application getting stopped.

2. Choose an integration approach that suits your requirements. See for more information.

3. Try and test our .

Whisk has its OpenAPI Specs published on Swagger to let you try out the API calls directly in your browser. You can call our API .

API
here
Integration Methods
OAuth
Recipe Search
here
Server Token
Client Token