Inleiding

<< Click to Display Table of Contents >>

Navigation:  »No topics above this level«

Inleiding

Gebruik de TimeWriter Soap API om records te maken, op te halen of bij te werken. De TimeWriter API kan in elke taal gebruikt worden die Web Services ondersteunt.

 

Authenticatie

Voor communicatie met de TimeWriter API zijn een API key en User key nodig. Met deze keys moet vervolgens ingelogd worden om een security token te verkrijgen (zie: Inloggen). Het security token wordt vervolgens gebruikt als authenticatie in de aanroepen.

De keys zijn in de TimeWriter applicatie te vinden in module Taken en instellingen | Instellingen | TimeWriter API (zie afbeelding). Druk op Bewerk om de Keys te kopiëren.

 

ApiKeys

 

API key

Deze sleutel geeft toegang tot de gegevens van de TimeWriter licentiehouder.

 

User Key

Deze sleutel geeft toegang tot de administratie (archief). Ieder archief heeft een eigen user key.

 

Security token

Het security token is nodig voor het doen van API aanroepen. Zie Inloggen

 

WSDL locatie

Het WSDL bestand definieert de API web service .

De locatie van het WSDL bestand is in de TimeWriter applicatie te vinden in module Taken en instellingen | Instellingen | TimeWriter API.

 

 

Algemene aanroep structuur

<?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:[Aanroep naam] xmlns:ns2="api.timewriter.nl">

    <securityToken></securityToken>

     ...

  </ns2:[Aanroep naam]>

</S:Body>

</S:Envelope>

 

Algemene antwoord structuur

<?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:[Antwoord naam] xmlns:ns2="api.timewriter.nl">

    <result>

      <error></error>

      <errorMessage/>

       ...

    </result>

  </ns2:[Antwoord naam]>

</S:Body>

</S:Envelope>