Timekit developers

Introduction

This page will help you get started with Timekit. You'll be up and running in a jiffy!

The Timekit API is organized around REST. Our API is designed to follow common HTTP conventions including response codes to indicate both errors and successful requests. Standard HTTP verbs (GET, POST, PUT, DELETE) are used for all methods, no exceptions.

JSON will be returned in all responses from the API, including error messages.

Root endpoint, versions and protocol

All API calls should be made to https://api.timekit.io/v2 (note the explicit versioning). The current public version of the API is version 2 and is the only publicly supported version (calls to v1 will result in 404 Not Found).

HTTP over TLS 1.2 is enforced for all calls, so non-secure calls will result in a 301 Moved Permanently pointing to the https URI.

CORS

Our API is intended to be consumed both by browser clients (e.g. SPAs) and servers and supports cross-origin resource sharing. As of right now, JSONP is not supported, but we'd love to hear from you if it's of interest.

Application context

We provide a simple mechanism for scoping usage of the API by "tagging" all requests with an app slug. Read more about the application context here

For demo purposes in the documentation, this value is always shown as "back-to-the-future", which you should replace with your own app slug.

UUID as IDs

All IDs used by Timekit are UUIDs. A UUID looks like this: de305d54-75b4-431b-adb2-eb6b9e546014 Read more about UUIDs here