Introduction

Use the TimeWriter Soap API to get, create and edit records. The TimeWriter API can be used in every language which supports Web Services.

Authenticate

You need an API key and a User key to communicate with the TimeWriter API. Use this keys to obtain a security token (see Log in). This token must be used in all other API requests.

You can find the keys in the TimeWriter application in the module Tasks and settings | Settings | TimeWriter API (see screenshot). Press Edit for copying the keys.

API key

This key gives you access to the data of the TimeWriter license holder.

User Key

This key gives you access to the administration (archive). Every archive has got its own user key.

Security token

The security token is necessary to make API requests. See Log in.

WSDL location

The WSDL file defines the API web service.

You can find the WSDL location in the TimeWriter application Tasks and settings | Settings | TimeWriter API.

General API request structure

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

<ns2:[API request name] xmlns:ns2="api.timewriter.nl">

...

</ns2:[API request name]>

</S:Body>

</S:Envelope>

General API response structure

<?xml version="1.0" encoding="utf-8"?>

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header/>

<S:Body>

<ns2:[API response name] xmlns:ns2="api.timewriter.nl">

...

</result>

</ns2:[API response name]>

</S:Body>

</S:Envelope>