Überblick über die REST-Schnittstelle

Ihr Timicx-System per REST-Schnittstelle bedienen

Timicx bietet zum Anlegen, Ansehen und Bearbeiten aller im System vorhanden Daten eine REST-Schnittstelle an. Diese kann genutzt werden um tägliche Aufgaben zu automatisieren oder auch andere Anwendungen an Timicx anzubinden. In diesem Dokument sind alle vorhanden Datenobjekte (wie beispielweise Mitarbeiter, Projekte oder Zeitbuchungen) und deren Zugriffsmethoden beschrieben.

Sie können die Schnittstelle direkt mit der URL Ihres Timicx-Systems ansprechen. Die URLs einzelner Aktionen setzen sich aus dem Namen Ihres Systems, einer Kennung für die Webservice-Version und einem aktionspezifischen Teil zusammen. Die Basis-URL der aktuell gültigen Version 2.0 der Schnittstelle ist für alle Aktionen:

https://<ihre domain>.timicx.net/ws/2.0

Aktionspezifische Anfrageadressen (z.B. für das Abfragen eines Mitarbeiters oder zum Anlegen einer Zeitbuchungen) sind in den entsprechenden Abschnitten dieser Dokumentation beschrieben.

Authentifizierung

Die Authentifizierung gegenüber ihrem Timicx-System erfolgt per HTTP-Authentifizierung (engl.: HTTP Basic access authentication).

Jeder aktive Mitarbeiter des Systems kann sich mit den gleichen Zugangsdaten anmelden, die er auch in der Web-Oberfläche verwendet. Weitere Zugansdaten werden nicht benötigt.

Version

Support

Für Fragen zur REST-Schnittstelle können Sie sich jederzeit gern an unseren technischen Support unter support@timicx.de wenden.