Introduction

Overview

What is Konbini?

At its core, Konbini is a universal ecommerce API that lets you connect to stores based on any of our supported platforms (like Shopify, WooCommerce or Magento) using a single, developer-friendly, platform-neutral API.

Our mission is to give developers and businesses a much better way to work with ecommerce platforms than has been possible in the past. Traditionally, people looking to build products that integrate with ecommerce platforms have had two major ways to go about it:

  • Go all-in on targeting a single platform — like Shopify — and reap the benefits of deep integration, but also suffer the consequences of only having access to one segment of the market, as well as the risks potentially involved in relying on the good graces of a single platform.

  • Spend weeks, months, or years building integrations with as many different platforms as they can reasonably justify.

On top of that, even though every major platform now offers at least a basic API, many of these can be difficult and time-consuming to write robust integration code for.

Konbini hopes to solve all of these problems by abstracting a multitude of platforms behind a single, meticulously-designed API, and letting developers focus on their application code, rather than the idiosyncrasies of each platform they'd like to support.

How does Konbini work?

The typical flow of interacting with a merchant using Konbini looks like this:

  1. Your app adds a merchant to Konbini, either by directly providing platform-specific credentials, or using Konbini Link for a fully platform-agnostic merchant onboarding flow.

  2. Konbini begins an initial synchronization of the merchant's data. To provide a truly platform-neutral, reliable and performant API, read operations in the Konbini API are executed against a local, normalized cache of merchant data, rather than being passed through to the merchant's platform.

  3. The merchant is now active, and your app can freely interact with it using the API.

  4. When your app reads the merchant's data, it's returned from Konbini's local, normalized cache.

  5. When your app writes the merchant's data, the write operation is passed through to the merchant's platform. This ensures that the data in both Konbini and the merchant's platform is immediately affected.

  6. In the background, Konbini will receive real-time updates to the merchant's data (where supported by the platform), and periodically reconcile our cache with the merchant's platform, to ensure it's up-to-date.

  7. Optionally, your app can use webhooks to be notified in real time whenever the merchant's data in Konbini changes.