API

Die TimeTrack Rest API können Sie nutzen, um TimeTrack mit anderen Systemen zu verbinden. 

Stempeluhr

Mit diesem Endpoint können Sie:

  • Projekt-Stempeluhr abfragen
  • Projekt-Stempeluhr starten
  • Projekt-Stempeluhr pausieren
  • Projekt-Stempeluhr fortsetzen
  • Projekt-Stempeluhr stoppen
  • Arbeitszeit-Stempeluhr abfragen
  • Arbeitszeit-Stempeluhr starten
  • Arbeitszeit-Stempeluhr stoppen

Projekt-Stempeluhr

Projekt-Stempeluhr-Objekt hat folgende Parameter:

Feldname Typ Beschreibung
username Text Benutzername
email Text Eindeutige E-Mail Adresse, eindeutig
startedAt Text Start Zeitstempel
workedSeconds Integer Gestempelte Arbeitsdauer in Sekunden. Das ist die letzte gespeicherte Dauer. Wenn die Stempeluhr den Status „playing“ hat, muss diese Dauer jedes Mal neu berechnet werden. Formal für die Berechnung: workedSeconds = (CurrentDate – startedAt) – breakSeconds
breakSeconds Integer Gestempelte Pause in Sekunden. Das ist die letze gespeicherte Dauer. Wenn die Stempeluhr den Status „paused“ hat, muss dies Dauer jedes Mal neu berechnet werden. Formal für die Berechnung: breakSeconds = (CurrentDate – startedAt) – workedSeconds
playing Boolean true oder false, 0 oder 1
stopped Boolean true oder false, 0 oder 1
paused Boolean true oder false, 0 oder 1
clientName Text Kundenname
projectName Text Projektname
taskName Text Tätigkeit
note Text Notizen

Projekt-Stempeluhr abfragen

Bei der Abfrage der Stempeluhr muss immer ein Datum übergeben werden.

curl „https://testkonto.timetrackenterprise.com/api/v2/ext/timers/project_timer?username=hansm&date=2020-10-23T16:00:00.000Z“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{}‘

Projekt-Stempeluhr starten

Beim Start der Stempeluhr müssen folgende Daten übergeben werden: date, clientName, projectName, username

curl -X „POST“ „https://testkonto.timetrackenterprise.com/api/v2/ext/timers/project_timer/start“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{
„username“: „hansm“,
„clientName“: „Kunde 006“,
„projectName“: „Projekt 006_1“,
„date“: „2020-10-23T15:00:00.000Z“
}‘

Projekt-Stempeluhr pausieren

Beim Pausieren der Stempeluhr müssen folgende Daten übergeben werden: date, username

curl -X „POST“ „https://testkonto.timetrackenterprise.com/api/v2/ext/timers/project_timer/pause“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{
„date“: „2020-10-23T15:30:00.000Z“,
„username“: „hansm“
}‘

Projekt-Stempeluhr fortsetzen

Beim Fortsetzen der Stempeluhr müssen folgende Daten übergeben werden: date, username

curl -X „POST“ „https://testkonto.timetrackenterprise.com/api/v2/ext/timers/project_timer/resume“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{
„date“: „2020-10-23T15:30:00.000Z“,
„username“: „hansm“
}‘

Projekt-Stempeluhr stoppen

Beim Stoppen der Stempeluhr müssen folgende Daten übergeben werden: date, username

curl -X „POST“ „https://testkonto.timetrackenterprise.com/api/v2/ext/timers/project_timer/stop“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{
„date“: „2020-10-23T15:30:00.000Z“,
„username“: „hansm“
}‘

Arbeitszeit-Stempeluhr

Arbeitszeit-Stempeluhr-Objekt hat folgende Parameter:

Feldname Typ Beschreibung
id Integer ID
user Text Benutzername
latitudeStart Number Start GPS Koordinaten – Latitude
longitudeStart Number Start GPS Koordinaten – Longitude
latitudeEnd Number Stop GPS Koordinaten – Latitude
latitudeEnd Number Stop GPS Koordinaten – Longitude
from Text Start Zeitstempel
to Text End Zeitstempel
workedMinutes Integer Dauer der Arbeit in Minuten
breakMinutes Integer Dauer der Pause in Minuten
manual Boolean Manuel angelegt oder nicht
notes Text Notizen

Arbeitszeit-Stempeluhr abfragen

Bei der Abfrage der Stempeluhr muss immer ein Datum übergeben werden.

curl „https://testkonto.timetrackenterprise.com/api/v2/ext/attendance_timer?username=hansm&date=2020-10-23T16:00:00.000Z“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{}‘

Arbeitszeit-Stempeluhr starten

Beim Start der Stempeluhr müssen folgende Daten übergeben werden: date, username

curl -X „POST“ „https://testkonto.timetrackenterprise.com/api/v2/ext/attendance_timer/start“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{
„username“: „hansm“,
„date“: „2020-10-23T15:00:00.000Z“
}‘

Arbeitszeit-Stempeluhr stoppen

Beim Stop der Stempeluhr müssen folgende Daten übergeben werden: date, username

curl -X „POST“ „https://testkonto.timetrackenterprise.com/api/v2/ext/attendance_timer/stop“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{
„username“: „hansm“,
„date“: „2020-10-23T15:00:00.000Z“
}‘

Ressourcen