API
Die TimeTrack Rest API können Sie nutzen, um TimeTrack mit anderen Systemen zu verbinden.
Kunden
Mit diesem Endpoint können Sie:
- Alle Kunden auflisten ohne Filter
- Alle Kunden auflisten mit Filter
- Bestimmten Kunden abrufen
- Neuen Kunden anlegen
- Bestehenden Kunden updaten
- Kunden deaktivieren
Kunden Objekt hat folgende Parameter:
| Feldname | Typ | Beschreibung |
|---|---|---|
| ID | Integer | ID |
| name | Text | Name des Kundens |
| enabled | Boolean | Kunde ist aktiviert oder deaktiviert. |
| color | Text | Farbe in RGB format |
| notes | Text | Notizen |
| Text | ||
| phone | Text | Telefon |
| address | Text | Adresse |
| address2 | Text | Zusatztext zur Adresse |
| addressZipCode | Text | PLZ |
| addressCity | Text | Stadt |
| addressCountry | Text | Landes Code ISO 2, z.B. DE, AT, CH |
| contactPerson | Text | Kontaktperson |
| field1 | Text | Freies Feld 1 |
| field2 | Text | Freies Feld 2 |
| field3 | Text | Freies Feld 3 |
Kunden auflisten ohne Filter
curl „https://testkonto.timetrackenterprise.com/api/v2/ext/clients/“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{}‘
Kunden auflisten mit Filter
Folgende Filter können verwendet werden:
| Feldname | Typ | Beschreibung |
|---|---|---|
| name | Text | Wird als Teilstring interpretiert. Z.b. mit „Mayer“ finden Sie alle Kunden die den Namen Mayer enthalten, z.b. Max Mayer, Robert Mayer Mustermann. |
In diesem Beispiel fragen wir nach den Kunden die in den Namen Mayer enthalten.
curl „https://testkonto.timetrackenterprise.com/api/v2/ext/clients?name=Mayer“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{}‘
Bestimmten Kunden abrufen
Pflichtparameter: ID des Kunden. Im folgenden Beispiel ist die ID 1.
curl „https://testkonto.timetrackenterprise.com/api/v2/ext/clients/1“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{}‘
Neuen Kunden anlegen
Beim Anlegen des Kunden können Sie alle Parameter des Kunden Objekts verwenden.
Pflichtparameter: name
curl -X „POST“ „https://testkonto.timetrackenterprise.com/api/v2/ext/clients“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{
„name“: „Kunde Herr Mayer“,
„field1“: „UID: DE12345678“
}‘
Bestehenden Kunden updaten
Beim Updaten des Kunden können Sie alle Parameter des Kunden Objekts verwenden, mit Ausnahme folgender Parameter: name, enabled.
curl -X „PUT“ „https://testkonto.timetrackenterprise.com/api/v2/ext/clients/6“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{
„email“: „mayer@timetrackapp.com“,
„field2“: „Test“
}‘
Kunden deaktivieren
curl -X „DELETE“ „https://testkonto.timetrackenterprise.com/api/v2/ext/clients/6“
-H ‚Content-Type: application/json‘
-H ‚X-TimeTrack-Api-Secret: <API_SECRET_TOKEN>‚
-H ‚X-TimeTrack-Api-Key: <API_KEY>‚
-d $'{}‘