Offene Schnittstelle

REST-API
für eigene Anbindungen

Die REST-API von Linetrack stellt Projekt-, Vorgangs- und Ressourcendaten für eigene Anbindungen bereit – als offene Standardschnittstelle der Plattform, wahlweise entwickelt durch Ihre IT oder durch Linetrack.

Kurzfassung

Die REST-API ist die offene Standardschnittstelle der Linetrack-Plattform: Sie liefert Projekt-, Vorgangs- und Ressourcendaten für eigene Anbindungen, wahlweise entwickelt durch Ihre IT oder durch Linetrack. Sie ergänzt die fertigen Anbindungen an ERP, AIDA, MS Project, Excel und SAP dort, wo noch keine vorgefertigte Schnittstelle existiert.

Datenzugriff

Was die REST-API bereitstellt

Die REST-API ist die offene Standardschnittstelle der Linetrack-Plattform für eigene Anbindungen.

Bereitgestellte Daten: Projekt-, Vorgangs- und Ressourcendaten für eigene Anbindungen.
Art der Schnittstelle: Offene Standardschnittstelle der Plattform.

Die vollständige Liste aller angebundenen Systeme steht auf der Integrationen-Übersicht.

Aufbau

Wie die Schnittstelle aufgebaut ist

Alle Endpunkte liegen unter einem versionierten Pfad und beantworten JSON. Die Version im Pfad ist eine Zusage: Ein Release ändert das Verhalten bestehender Endpunkte nicht.

/api/integrations/v1/

/companies

Firma und Stammdaten

Der Einstieg für jede Anbindung: Womit arbeite ich, und welche Schlüssel gelten in diesem Mandanten?

GET Firmenprofil
GET Nutzer
GET Gruppen
GET Kalender
GET Benutzerdefinierte Felder

/projects

Projekte und Vorgänge

Lesend für eigene Auswertungen, schreibend für Rückmeldungen aus dem Quellsystem. Projekte und Vorgänge lassen sich auch über Ihre eigene Kennung ansprechen.

GET Projektliste
GET Einzelnes Projekt
GET Projekt über Ihre eigene Kennung
GET Stunden-Report je Projekt
GET Vorgang über Ihre eigene Kennung
PUT Vorgang aktualisieren

/resources

Ressourcen und Auslastung

Der Teil, der am häufigsten läuft: Mitarbeiterstamm und Auslastungen kommen aus Personalsystem und Zeiterfassung und werden regelmäßig abgeglichen.

GET Ressourcen der Firma
GET Auslastungen
PUT Mitarbeiter abgleichen
PUT Virtuelle Ressourcen abgleichen
PUT Auslastungen einspielen
PUT Auslastungen ohne Personenbezug

Welche Endpunkte Ihre Anbindung tatsächlich braucht, hängt von der Richtung ab. Eine reine Auswertung kommt mit lesenden Zugriffen aus; ein Abgleich aus dem Personalsystem braucht genau einen schreibenden.

Zugang

Ein Schlüssel je Anbindung, jederzeit widerrufbar

Server-zu-Server-Anbindungen melden sich nicht als Person an. Sie tragen einen eigenen Schlüssel im Header, der auf genau einen Mandanten zeigt.

Ein Header, mehr nicht

Jede Anfrage trägt den Schlüssel als X-API-KEY. Kein Anmeldevorgang, keine ablaufende Sitzung, kein Token-Tausch vor jedem Aufruf.

Fest auf Ihren Mandanten gebunden

Der Schlüssel gehört zu Ihrer Firma und einem technischen Konto. Er kommt an keine Daten, die nicht Ihnen gehören – auch nicht versehentlich.

Benannt, damit man ihn wiederfindet

Jeder Schlüssel trägt einen Namen. Bei mehreren Anbindungen lässt sich einzeln zurückziehen, was nicht mehr laufen soll, statt alles auf einmal.

Widerrufbar statt austauschbar

Ein Schlüssel wird gesperrt und verliert sofort seine Wirkung. Ein Neustart der Anwendung ist dafür nicht nötig.

Nie im Klartext gespeichert

Hinterlegt wird nur ein Hash. Wer die Datenbank liest, bekommt den Schlüssel nicht zurück.

Jeder Aufruf steht im Protokoll

Zeitpunkt, Konto, Methode und Pfad werden mitgeschrieben. Wenn jemand fragt, woher ein Wert stammt, gibt es eine Antwort statt einer Vermutung.

In der Praxis

Ein Abgleich, wie er tatsächlich abläuft

Der häufigste Fall: Der Mitarbeiterstamm kommt aus dem Personalsystem. Sie liefern den ganzen Stand, Linetrack entscheidet je Satz, ob er neu ist oder aktualisiert wird.

Der ganze Stand statt einer Differenz

Sie schicken alle Mitarbeiter, nicht die Änderungen seit dem letzten Lauf. Ein ausgefallener Lauf hat damit keine Folgen – der nächste bringt alles wieder in Deckung.

Die Personalnummer ist der Schlüssel

Zugeordnet wird über die Personalnummer aus Ihrem System. Ein Namenswechsel nach der Hochzeit ist damit eine Aktualisierung und kein zweiter Mitarbeiter.

Teilerfolg ist ein Ergebnis, kein Fehler

Sätze, die nicht verarbeitet werden konnten, kommen einzeln zurück – mit Kennung und Grund. Der Rest des Laufs bleibt davon unberührt.

Der Lizenzstand steht in der Antwort

Wie viele Nutzerlizenzen nach dem Lauf frei sind, steht mit in der Antwort. Ihr Job merkt es also selbst, wenn es eng wird.

Datenschutz

Auslastung übertragen, ohne Namen zu übertragen

Auslastungsdaten aus einer Zeiterfassung sind personenbezogen, sobald ein Name daran hängt. In vielen Häusern scheitert genau daran die Anbindung – nicht an der Technik, sondern am Betriebsrat.

Für diesen Fall gibt es einen zweiten Weg für dieselben Daten: Statt Namen übergeben Sie eine Kennung, die Ihr System ohnehin führt – die interne Kennung der Ressource, ein Kürzel oder die Personalnummer. Linetrack löst sie im eigenen Bestand auf. Aus Ihrem System geht kein Name heraus.

Welche der drei Kennungen Sie verwenden, entscheiden Sie; die Schnittstelle nimmt alle drei entgegen.

Linetrack Auslastungsübersicht der Ressourcen über mehrere Abteilungen

Herausforderung

Warum nicht jede Anbindung als Standard existiert

Für AIDA, ERP-Systeme, MS Project, Excel und SAP sind die Anbindungen bereits entwickelt und laufen out of the box. Für ein firmenspezifisches System oder ein selbst gebautes Tool existiert dagegen keine vorgefertigte Schnittstelle.

Genau dafür stellt Linetrack eine offene REST-API bereit, über die sich Projekt-, Vorgangs- und Ressourcendaten auslesen lassen – etwa für eigene Auswertungen im Multiprojektmanagement.

Auch für ERP-Systeme, die noch nicht zu den fertigen Anbindungen zählen, lässt sich über die REST-API eine eigene Verbindung bauen – Details zu den bereits fertigen ERP-Anbindungen auf der Seite zur ERP-Integration.

Zugang und verfügbare Endpunkte werden dafür vor dem Projektstart im Kontaktgeklärt.

REST-API in Linetrack: verbundene Termin- und Kapazitätsplanung

Wirkung in der Praxis

Anbindung für den Sonderfall

Für AIDA, ERP-Systeme, MS Project, Excel und SAP existieren bereits fertige Anbindungen. Für alles darüber hinaus – ein firmenspezifisches System, ein selbst gebautes Tool – liefert die REST-API den offenen Zugang.

Zugang und verfügbare Endpunkte werden dafür vor dem Projektstart geklärt.

FAQ

Häufig gestellte Fragen

Noch Fragen?

Buchen Sie sich einen Termin mit unserem Team.

Welche Daten liefert die REST-API?

Die REST-API liefert Projekt-, Vorgangs- und Ressourcendaten für eigene Anbindungen – als offene Standardschnittstelle der Linetrack-Plattform. Vorgangsdaten entsprechen dabei den Daten, wie sie auch im Taskmanagement geführt werden.

Für wen ist die REST-API gedacht?

Für Systeme, für die es keine fertige Anbindung gibt. Die Verbindung kann wahlweise durch die IT des Kunden oder durch Linetrack gebaut werden.

Wie bekomme ich Zugang zur REST-API?

Zugang und verfügbare Endpunkte werden vor dem Projektstart geklärt.

Unterscheidet sich die REST-API von den fertigen Anbindungen an AIDA, ERP-Systemen oder SAP?

Ja. Die Anbindungen an AIDA, ERP-Systeme, MS Project, Excel und SAP sind bereits entwickelt und laufen out of the box. Die REST-API ist die offene Schnittstelle für alles, wofür es noch keine fertige Anbindung gibt.

Wie authentifiziert sich eine Anbindung?

Über einen API-Schlüssel im Header X-API-KEY. Der Schlüssel gehört zu genau einem Mandanten und einem technischen Konto, wird nur als Hash gespeichert und lässt sich jederzeit sperren. Für Anbindungen zwischen Servern ist das der vorgesehene Weg – ein Anmeldevorgang mit Benutzername und Passwort ist dafür nicht nötig.

Ist die Schnittstelle versioniert?

Ja. Alle Endpunkte liegen unter /api/integrations/v1/. Die Version im Pfad ist eine Zusage an Ihre Anbindung: Das Verhalten bestehender Endpunkte ändert sich innerhalb einer Version nicht.

Können wir mit unseren eigenen Kennungen arbeiten?

Ja. Projekte und Vorgänge lassen sich über eine Kennung aus Ihrem Quellsystem ansprechen, die als benutzerdefiniertes Feld hinterlegt ist. Ihre Anbindung muss die internen Kennungen von Linetrack also nicht mitführen.

Was passiert, wenn einzelne Datensätze nicht verarbeitet werden können?

Der Lauf bricht nicht ab. Die Antwort weist getrennt aus, wie viele Einträge angelegt und wie viele aktualisiert wurden, und listet die nicht verarbeiteten Sätze einzeln mit Kennung und Grund auf. Beim nächsten Lauf werden sie erneut mitgeliefert.

Lassen sich Auslastungsdaten ohne Personenbezug übertragen?

Ja. Für Auslastungen gibt es einen zweiten Weg, der statt Namen eine Kennung entgegennimmt – die interne Kennung der Ressource, ein Kürzel oder die Personalnummer. Die Zuordnung passiert in Linetrack, aus Ihrem System geht kein Name heraus.