Flipdish

The Flipdish Developer Hub

Welcome to the Flipdish developer hub. You'll find comprehensive guides and documentation to help you start working with Flipdish as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting Started with Flipdish API

API Reference

To interact with Flipdish API you will need a Flipdish account. Please contact us if you don't have an account and would like one.

Visit https://app.flipdish.com/developers and you'll be presented with an API key after creating your first Flipdish App.

Create your Flipdish App

What is a Flipdish App

We use the term "Flipdish App" for any integration, module or application built on top of the Flipdish API.
Some code samples may use the term "client" instead of "Flipdish App"

After you get your Flipdish account please visit https://app.flipdish.com/developers where, after clicking to the "CREATE NEW APP" button, the following popup will be displayed. Simply give a name to your future Flipdish App and press "CREATE APP".

Get your API Access Token

Flipdish uses OAuth2 to manage authentication. If you aren't familiar with OAuth2, that's fine. We'll walk you though the basics.

Every Flipdish App uses Hybrid Flow, which allow to request a combination of identity token, access token and code via the front channel using either a fragment encoded redirect (native and JS based clients) or a form post (server-based web applications).

Through the Flipdish Developers Portal you can get access tokens, which allows you to access your stores, orders, vouchers and many resources via the API.

To request access tokens grammatically you need your App's ID and Secret Key. Both can be found under "Dashboard" section.

For security reason secret key is hidden on Flipdish Developer Portal by default.

Please use the "REVEAL SECRET KEY" button to get your key and keep it in a safe place.

Request a token using IdentityModel and C#.

TokenClient client = new TokenClient(
    "https://api.flipdish.co/identity/connect/token",
    "<your_client_id>",
    "<your_secret_key>");

string accessToken = client.RequestClientCredentialsAsync("api").Result.AccessToken;

Authentication

Token Types

Secret Key: a token accessed only by you (the App owner) and Flipdish. This should not be exposed to customers or 3rd parties.

Access Token (also know as a Bearer Token): a token which is used when making calls to the Flipdish API.

Authenticate by including the header Authentication with your OAuth Bearer token (AKA access token).

curl --request GET \
  --url https://api.flipdish.co/api/v1.0/orders/1 \
  --header 'Authentication: Bearer <your Access Token>'

Always use HTTPS

Calls made over plain HTTP will fail. API requests without authentication will also fail.

Get started

Visit the API Reference Docs to see a list of available endpoints and test out the API.