App based auth

Before you can start using our API you must sign up via our admin interface to register a new account (also known as "app" in technical terms).

In the admin interface, navigate to the "API Settings" section where you'll find your App API Key. This is the API Key that you'll use to authenticate with our API when making API requests.

Uses Basic Authentication

We use Basic Authentication over HTTPS. It's simple to use and works across almost every platform and code language available.

Note that basic auth usually requires a email/user-name and a password. But since the API key is tied directly to your app only, we don't need the email as identifier. This means that the username must be empty and the API key is the password. Do not send a placeholder username (such as api or x): a non-empty username is treated as an account email address and the request will fail with 401 Unauthorized.

Server-side integration

Calling our API is straightforward and only requires that the "Authorization" HTTP header is set to your API key. With most HTTP toolkits and SDKs, you don't have to set this manually.

Make a request using cURL

curl
curl --request GET \
  --url https://api.timekit.io/v2/bookings \
  --header 'Content-Type: application/json' \
  --user :live_api_key_7nzvc7wsBQQISLeFSVhROys9V1bUJ1z7

Make a request using our Javascript SDK

javascript
var timekit = require('timekit-sdk');

timekit.configure({
  appKey: 'live_api_key_7nzvc7wsBQQISLeFSVhROys9V1bUJ1z7'
})

timekit.getBookings()
.then(function(response){
  console.log(response);
}).catch(function(response){
  console.log(response);
});

You can find documentation for our JS SDK on Github.

Client-side integration

When calling our API from a client-side use-case, we're using a different key that's safe to expose publicly in your frontend. This only grants access to selected endpoints and only exposes a limited set of information. Calling an endpoint that requires the App API Key with the App Widget Key returns 403 Forbidden. In most cases, this key is only used for out booking widget called booking.js.

In our admin interface, navigate to the "API Settings" and look for the App Widget Key.

Embedding our widget in a webpage is in most cases as easy as copying the embed code found in our admin panel. Just navigate to your project and click the "Share" button - the embed code already includes your App Widget Key.