If you are interested in synchronizing your existing data infrastructure (database, Ticket system, Issue Tracking, ERP/CRM software, …) with timr you can use our API. Using the API is free of charge in all paid timr plans.
1. REST API
With the timr REST API, you connect timr to your existing systems and keep your data in sync automatically – with no manual transfer.
What the REST API offers
You can access the following data, among others:
- Employees, teams, and work time models
- Working times and project times
- Tasks including assignments
- Drive log (drives, vehicles, categories)
You can find a complete overview of all endpoints in our developer documentation: https://developer.timr.com/
The API base URL is https://api.timr.com/v1.
Requirements
- You need administrator rights in timr.
- Decide in advance which grant type to use:
client_credentials(machine-to-machine, without user login) orauthorization_code(with user login). Learn more about grant types here: Choosing the right grant type - For the Authorization Code Flow, you need at least one absolute redirect URL.
How to create your API access credentials
- Open the timr web application.
- Go to Administration → Settings → Integrations.
- Under API Credentials, click + Add.
- Enter a name and select the grant type.
- Click Save.
You will then receive an OAuth Client ID and an OAuth Client Secret.
Note: Keep the Client Secret in a safe place – it contains sensitive information of your employees.
The REST API authenticates via OAuth2. For detailed information on grant types, scopes, the token endpoint, and example requests, see the article OAuth2 authentication for the timr REST API.
2. timrLink
In addition to the API, we also offer timrLink. With a simple configuration and without implementing the API yourself, it lets you define which entities of your infrastructure are synchronized with timr and on which schedule. Please contact us for detailed timrLink pricing.
3. SOAP API
Note: The SOAP API remains available for existing integrations. For new integrations, we recommend the REST API (see above). The SOAP API will be maintained as legacy going forward and will no longer be developed further.
Note: The token for the SOAP API is currently created directly by our team. Please contact us at info@timr.com.
Download the WSDL
You can download the timr API WSDL here: https://timrsync.timr.com/timr/timrsync.wsdl
Create a token
- Go to Administration → Settings.
- In the Integrations tab, generate a token in the SOAP API field.
This token serves as the password for the connection to the web service API.
Note: A regular user account cannot be used for the connection.
Login credentials
- Username: your identifier (= your timr URL – for
mustermann.timr.com, the identifier ismustermann) - Password: your authentication token
Sending requests
Send your requests as a POST to https://timrsync.timr.com/timr/timrsync using HTTP basic authentication (identifier as the username, token as the password).
Example request – retrieving users:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tim="http://timr.com/timrsync">
<soapenv:Header/>
<soapenv:Body>
<tim:GetUsersRequest/>
</soapenv:Body>
</soapenv:Envelope>Testing tools
To test the API and build your client, we recommend soapUI or Visual Studio .NET.
Code examples
We provide example implementations for Java and .NET:
- Java: https://github.com/troii/timrsyncclient – an example using spring-ws and JAXB marshalling that calls the
getTasksmethod (retrieves all tasks created in your timr account). - .NET: https://github.com/troii/timrsync-dotnet-testclient
If you have any questions about the API, please contact us at info@timr.com!
Comments
0 comments
Please sign in to leave a comment.