Transactional API

Einleitung

Unsere Transactional API ermöglicht Ihnen die Integration von TimeLog mit anderen Systemen und eine homogenere IT-Landschaft. Sie finden die Einstellungen unter Systemadministration -> Integrationen und API -> Einstellungen für Transactional API.

Beschreibung

API ist die Abkürzung für Application Programming Interface. Wenn Sie keine Erfahrung mit der Entwicklung und Verknüpfung von Systemen haben, kann es schwierig sein zu verstehen, was eine API wirklich ist. Deshalb beschreiben wir Ihnen hier kurz, worum es sich dabei handelt.

Was ist eine API?

Eine API ist ein Tool, das die Kommunikation zwischen Softwaresystemen ermöglicht. Damit können Sie Daten zwischen Systemen hin und her senden und in Echtzeit aktualisieren, sodass Sie in allen Systemen immer über die neuesten Daten verfügen.

Hier einige Beispiele:

• Informationen aus TimeLog zu Dashboards in Power BI
• Übertragung von Rechnungen aus TimeLog an Ihr Finanzsystem
• Übertragung von Lohndaten zur Verarbeitung in Ihrem Lohnsystem
• Aktualisierung von Kontaktinformationen von Ihrer Website in Ihrem CRM-System

Die Verwendung einer API bietet unter anderem folgende Vorteile:

• Sie ersparen sich zahlreiche manuelle Eingaben, wenn Daten zwischen den Systemen automatisch ausgetauscht werden können.
• Sie erhalten immer die richtigen Daten mit fortlaufenden Aktualisierungen in Echtzeit.
• Ihre Entwickler können neue Lösungen schneller und einfacher entwickeln sowie Systeme in Ihrer IT-Umgebung miteinander verknüpfen.

Wofür kann ich TimeLogs Transactional API verwenden?

Sie können die API verwenden, um Daten zwischen mehreren Systemen zu synchronisieren. Sehen Sie sich die folgenden zwei Beispiele an.

Beispiel 1:

Wenn Sie ein CRM-System außerhalb von TimeLog nutzen, können Sie die Transactional API dazu verwenden, Ihre Kundendatenbank in TimeLog mit den gleichen Informationen zu aktualisieren, die Sie in Ihr CRM-System eingeben, darin ändern oder von dort löschen.

Beispiel 2:

Sie verwenden ein externes System zur Angebotserstellung für Projekte. Sobald ein Angebot vom Kunden angenommen wurde, können Sie über die Transactional API direkt ein Projekt in TimeLog erstellen.

Im Allgemeinen können Sie die API verwenden, um Daten abzurufen, zu erstellen, zu aktualisieren und zu löschen.

Einrichtung und Aktivierung der TimeLog Transactional API

Sie müssen die API mit Ihren TimeLog URL aktivieren, bevor Sie Integrationen verwenden oder eigene für TimeLog erstellen können.

Wir empfehlen Ihnen, für die Einrichtung der API einen zusätzlichen Benutzer anzulegen. Diesen benötigen Sie, um Zugang zu den API-Methoden zu erhalten. Außerdem vermeiden Sie dadurch, dass die Verbindung deaktiviert wird, sobald jemand seine Zugangsdaten ändert oder nicht mehr bei Ihnen beschäftigt ist.

Externe Systeme

Sie erhalten eine Liste der mit Ihrem TimeLog integrierten Systeme. Dabei kann es sich beispielsweise um ein Finanz-, Lohn- oder Filesharing-System handeln.

Sie können ein neues System erstellen:

1. Klicken Sie auf Neues externes System.
2. Fügen Sie den Systemschlüssel aus dem neuen System hinzu.
3. Fügen Sie eine Beschreibung des Systems hinzu, das nachfolgend in der Liste aufgeführt wird.
   Klicken Sie auf Speichern.

Was ist die REST API?

Bei der REST API handelt es sich um einen neueren Standard, in den wir gerade die Methoden aus unserer Transactional API und der Reporting API überführen. Nach einer längeren Übergangszeit mit Verwendung beider APIs werden alle Methoden in REST verfügbar und alle Kunden darauf umgestiegen sein.

Die REST API bietet Ihnen zusätzliche Optionen. Während Sie in der Reporting API nur Daten abrufen können, werden Sie nun die Möglichkeit haben, sie außerdem zu aktualisieren oder zu löschen. Neue Methoden werden nur unserer REST API hinzugefügt.