API Documentation

# Getting Started

# APIs

We publish several APIs for partners to access information regarding our brands, restaurants and menus, serve images with on the fly resizing, place orders and more.

An overview of each API along with request parameters and response objects for each API endpoint and operation have been documented and can be found in the navigation menu at the top of this site.

Individual APIs are published via our API gateway in production and staging. You are granted access to the APIs by way of an API Key.

Depending on what you need access to, you may be assigned multiple API keys so please bear that in mind while designing an authentication strategy for the applications you are writing.

# Version 2 APIs

We currently publish v1.x and v2.x API versions for partners to consume.

Below is some information regarding the road map for our API versions.

  • Over time, we will publish version 2 of more of our APIs and these newer versions will replace the older versions.
  • The newer APIs and API versions will mostly use OAuth 2.0 Bearer tokens for authentication instead of API keys.
  • There will be a period of time where an API is available in both versions.
  • Once our partners have migrated to use newer versions, we will decommission the older API versions and remove the documentation.
  • There is no timeline set for publishing of new versions or for the decommissioning of the older versions.

# Environments

We publish APIs into two environments. Alongside our production environment, we have a staging environment that is available for use. We will use the staging environment for integrated testing and to demonstrate new API functionality to partners.

The staging environment is a pre-production environment. Although we treat it with the same care as we do for our production environment, the data stores in staging will be refreshed from time to time. Staging must not be used for production workloads under any circumstances.

API keys are unique per environment. Keys intended for production will not work in staging and visa-versa.

# Gateway URLs

The API gateway URLs for production and staging will be provided to you when you are granted access to the APIs.

# Deployments

All API updates will be deployed into the staging environment before they are deployed to production. Each API page will indicate the production and staging deployment status.

Authentication →