BookingBug Developer Documentation

The BookingBug Developer Hub

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

Get Started    Guides

Introduction

Bookingbug is a booking platform used by various businesses across the globe. Many of the businesses use the Bookingbug API to automate and enhance their booking journeys with Bookingbug.

The API

This is the documentation for the Bookingbug API v1. The BookingBug REST API is a HAL based API that allows you to manage all aspects of the BookingBug platform.

Endpoints are documented with the HTTP method for the request and a partial resource identifier.

GET /api/v1/1234/services

Prepend your Bookingbug URL to the resource identifier to get the full endpoint URL:

https://uk.bookingbug.com/api/v1/1234/services

Curly braces, {}, indicate values you have to replace. Example:

https://{host}.bookingbug.com/api/v1/{company_id}/services/{id}

The examples provided in the docs are cURL statements. You can run the statements on a command line to try out or use REST API client, such as postman.

API Keys

The Bookingbug API requires App-id and App-keyto be parsed in the HTTP header for each call. These keys can be obtained by contacting your BookingBug Account manager or primary contact.

-H "App-id: {app-id}" -H "App-key: {app-key}"

To find the App-id please follow the steps below:

  1. Login to your BookingBug Environment using an account with parent-level privileges
  2. Click on the cog icon on the top right-hand corner
  3. Click on Advanced Settings on the left hand side
  4. Click on API Settings
  5. App-Id (this is the long id)

Please note

New customers will only require App-id and not App-key. This also means you only need to define the App-id in the headers.

Permission

The Bookingbug platform is separated into three different APIs:

  1. Public - The public API does not require authentications and it enables you to get information about services, resources, events, add items to the basket, view basket and checkout.
  2. Member - The member API enables you to log in as a member, make bookings and amend or cancel their previously made bookings.
  3. Admin - The admin API enables you to administer the account, such us create or amend people, resources or clients and view bookings.
    The request format of the three APIs are:

Public

/api/v1/{company_id}

Member

/api/v1/{company_id}/members/

Admin

/api/v1/admin/{company_id}

Company ID

The company ID is a unique identifier that identifies the company. To find your company ID please follow the steps below:

  1. Login to your BookingBug Environment using an account with parent-level privileges
  2. Click on the cog icon on the top right-hand corner
  3. Click on Advanced Settings on the left-hand side
  4. Click on API Settings

Request Format

The Bookingbug API is a JSON API. You must supply a Content-Type: application/jsonheader in PUT and POST requests. You must set an Accept: application/json header on all requests.

Data Types

The API returns and accepts JSON values, which can be strings in double quotes, numbers, objects, arrays, true or false. Most programming languages have tools to parse this data.

Time stamps

Time stamps use UTC time and are formatted as ISO 8601 strings. Example: '''2016-05-16T09:14:57Z'''.

Pagination

By default, most list endpoints return a maximum of 30 records per page. You can change the number of records on a per-request basis by passing a per_page parameter in the request URL parameters. Example: per_page=50.

When the response exceeds the per-page maximum, you can paginate through the records by incrementing the page parameter. Example: page=3. List results include next and previousURLs in the response body for easier navigation:

      },
  "_links": {
    ...
    },
    "next": {
      "href": "https://uk.bookingbug.com/api/v1/admin/50666/bookings?page=3&per_page=30&locale=en"
    },
    "previous": {
      "href": "https://uk.bookingbug.com/api/v1/admin/50666/bookings?page=1&per_page=30&locale=en"
    }
  }
}

This documentation will cover the main aspects of the API and how you can use it within your application. There are many different features within the API and we will only be covering some of the aspects that you will need to get set up. If you have further questions regarding the use of the API then you can email apisupport@bookingbug.com

For a full list of endpoints and methods see the API Reference