App context

We provide a simple mechanism for tracking and bucketing app developers usage of the API by "tagging" all requests with an app ID. Whenever you make an API call, the app ID should included.

Timekit-App setting

Add the app context with a custom HTTP header called "Timekit-App", like so:

curlcurl -X GET \
     -H 'Timekit-App: back-to-the-future' \
     -u doc.brown@timekit.io:nvHfRSlhvsnlg4rS7Wt28Ty47qdgegwSu3YK7hPW \
     https://api.timekit.io/v2/resources/me

In cases where its not possible to set a HTTP header (e.g. in webhooks on third-party services), you can provide a query param named "Timekit-App" in the URL instead:

curlcurl -X GET \
     -u doc.brown@timekit.io:nvHfRSlhvsnlg4rS7Wt28Ty47qdgegwSu3YK7hPW \
     https://api.timekit.io/v2/resources/me?Timekit-App=back-to-the-future

Register new app

For demo purposes in the documentation, the app slug in examples are always set to "back-to-the-future". You cannot use this yourself and must replace it with your own app slug.

If you start making requests outside the documentation (e.g. in production apps), you need to register your app: Create an admin user and register your app form

The "app slug" is the value you should use in your requests.

We'd love to hear from you on what you're planning to build, so don't hesitate to contact us!