TimeTrack uses App Key and App Secret for authentication. You can get App Key and App Secret in Web-App / Settings / General / API. Use App Secret and App Key in every request like in this example:
-H ‘Content-Type: application/json’
-H ‘X-TimeTrack-Api-Secret: <APP_SECRET_TOKEN>‘
-H ‘X-TimeTrack-Api-Key: <APP_KEY>‘
App Key and Secret will be automatically generated for you. You can generate new App Secret anytime.
<APP_SECRET_TOKEN> has to be replaces by your App Secret from Web-App / Settings / General / API.
<APP_KEY> has to be replaces by your App Key from Web-App / Settings / General / API.
In the following example we will be using TESTACCOUNT as Example account. Make sure to use your account during the implementation.
For READ Requests the records will be returned in pages. If you don’t send page or limit, you will get 50 records.
You can control paging with “page” and “limit“. You need to pass them with other URL parameters. Max values for limit is 1000 records.
All requests and responses are in JSON format.
Date format is YYYY-MM-DD. Examples: 2020-10-23, 2020-01-01
Timestamp YYYY-MM-DDTHH:MM:SSZ. Examples: 2020-10-23T14:30:00Z, 2020-10-23T00:00:00.000Z
Number formats, Example: hourRate 20.5.
Booleans, Example: true or false, 1 or 0
Errors will be presented in following format:
“title”: “TimeEntry exist but it is deleted”,
“detail”: “TimeEntry is deleted and can not be used.”
Title returns the main error message.
|401||Authentification didn’t work, please check App Key and Secret.|
|403||Action not allowed|
|404||Record not found|
|422||Conflict on update or params are wrong|
|500||Internal server error|
Code ist internal error code that can help us find the cause, please send it to us if you have any problems.
Detail: gives more information about the error, if available.
Currently request rates are limited to 30 requests per minute. For On-Premise clients we can change this value.