API v3 Overview

REST API

The bookingkit API is designed as a RESTful API. All data is returned in JSON format, so it can be easily used in all environments.

Authentication

Every request to the API requires a valid token. Tokens can be requested from https://api.bookingkit.de/oauth/token with the provided client_id, client_secret, and grant_type.

More information on authentication can be found in the Authentication guide.

Basic Request Structure

Building URLs

The current version of the API is v3, so all requests will be sent to:

https://api.bookingkit.de/v3/

To request a resource collection, append the name of that collection to the URL, like so:

https://api.bookingkit.de/v3/events/

To load a single item, use its ID as in this example:

https://api.bookingkit.de/v3/events/0cc175b9c0f1b6a831c399e269772661/

Related resources may also be requested:

https://api.bookingkit.de/v3/events/0cc175b9c0f1b6a831c399e269772661/dates/

More information on API URLs for each environment can be found here.

Documentation of endpoints can be found here.

Filtering Results

Resource collections can and should be filtered to fit individual needs. A complete list of query parameters can be found for each request. The order of the query parameters is not important, and all are optional, so only the needed ones must be sent.

https://api.bookingkit.de/v3/dates/?start_date=2016-01-01T10:00:00Z&limit=10

Overriding the HTTP Method

Clients that cannot send PATCH or DELETE requests may also send a POST request and append the query parameter method to override the HTTP request type. Only the values PATCH and DELETE are accepted.