Getting Started with the Transactional API

Use these steps to get started with exchanging data between TimeLog and other business systems.

Accessing the Transactional API requires normal TimeLog credentials. Currently, no special API user exists. For most usages, the recommendation is to use a system administrator role for all interactions. However, lesser privileges will also work for some requests.

This guide is using the TimeLog SDK and all example are written in C#. However, the API does not require .NET for interaction, but the SDK is (as of writing) only available for .NET.

1. Get URL and credentials

Take note of your TimeLog URL. In most cases, it would follow the pattern below. [X] is replaced by a number and the [account name] is the same you use for login.

https://app[X][account name]

Obtain certain credentials to use for the API requests. You should test your URL and credentials on the login portal. If they work there, they would work in the API.

2. Activate the API

Using a user with the standard system administrator role or similar, activate the API endpoint through the system administration. Click the personal menu (top right corner), choose System Administration, then Integrations and API then API settings (WCF).

Make sure the check box for activation is selected. Also enable all modules and as a best practice we encourage all to ensure HTTPS for all API connections.

3. Setup your project

Create a new .NET project, download the Transactional API DLLs from GitHub.

Add the DLLs as references in your project.

Add the following keys to the appSettings-section in web.config or app.config and fill them with appropriate values as step 2.

<add key="TimeLogProjectUri" value="" />
<add key="TimeLogProjectTransactionalUsername" value="" />
<add key="TimeLogProjectTransactionalPassword" value="" />

If you are not using the SDK, instead find the service URLs and add the web service references to your project. You may find the full source code for the .NET SDK on GitHub and copy some of the same constructs to other languages.

4. Obtain a Security Token

In order to access any of the Transactional API services, you need a Security Token that grants you access. The Security Token is obtained through the GetToken-method from the latest Security Service.

Using the SDK however, you can use the SecurityHandler.Instance.TryAuthenticate-method directly without additional thinking on versions and constructs.

IEnumerable<string> messages;
if (SecurityHandler.Instance.TryAuthenticate(out messages))
    Console.WriteLine(string.Join(",", messages));

If succesful, the token is automatically cached and will be available from SecurityHandler.Instance.Token.

5. Execute other Methods

Now you are ready to access other services. Inside the TryAuthenticate construct from step 4, you may execute other methods and for each of the handler available as part of the SDK you will find an appropriate Token property matching the namespace needs.

The example below will get all time registrations for the user "tkj".

var result = ProjectManagementHandler.Instance.ProjectManagementClient.GetWorkPaged("tkj", new DateTime(2015, 1, 1), new DateTime(2015, 4, 1), 1, 350, ProjectManagementHandler.Instance.Token);
if (result.ResponseState == ExecutionStatus.Success)
    foreach (var obj in result.Return)
    foreach (var apiMessage in result.Messages)

6. Get Creative

Now it is time to get creative and use the TimeLog data or automatically create new TimeLog data based on information in other systems.

Get in contact with us for recommendations on usage, and if you have ideas for new methods - or if you encounter bugs.