REST-API

Zeitwart soll nicht die einzige Software sein, die etwas über deine Räume weiß. Über die REST-API fragen andere Systeme ab, welche Räume es gibt und wann sie belegt sind – für ein Intranet, eine Anzeigetafel, ein Auswertungswerkzeug oder eine eigene Anwendung.

Anmeldung über ein Token

Der Zugriff läuft über ein Bearer-Token, das du an einem Benutzerkonto erzeugst. Das Token trägt exakt die Rechte dieses Kontos – es ist also kein Generalschlüssel, sondern erbt die normale Rechtestruktur aus Rollen und Organisationseinheiten.

Für eine Integration legst du deshalb am besten ein eigenes Dienstkonto mit knapp geschnittener Rolle an, statt das persönliche Konto eines Administrators zu verwenden. Fällt das Token in falsche Hände, ist der Schaden auf das begrenzt, was dieses Konto ohnehin durfte.

Das Token wird aus Sicherheitsgründen genau einmal angezeigt und lässt sich danach nicht mehr auslesen. Geht es verloren, erzeugst du ein neues.

Was sich abfragen lässt

• die für das Konto sichtbaren Räume und Ressourcen

• deren Buchungen für einen wählbaren Zeitraum

• die zugehörigen Stammdaten samt der eigenen Attribute

Eine ausführliche Dokumentation aller Endpunkte – inklusive Postman-Sammlung zum Ausprobieren – bekommst du über den Support.

Wann die API das richtige Werkzeug ist

Die API ist der Weg, wenn dein System Zeitwart fragt. Soll es umgekehrt sein – Zeitwart meldet ein Ereignis an dein System, etwa zum Start einer Buchung –, sind Webhooks der passendere Mechanismus. Und wer nur Termine anzeigen will, kommt mit einem iCal-Feed meist schneller ans Ziel.

Für fest installierte Geräte ohne Anmeldung gibt es zusätzlich eine IP-gebundene Login-URL am Konto.

Vorteile auf einen Blick

• Zugriff über Bearer-Token, erzeugt am Benutzerkonto

• Token erbt die Rechte seines Kontos – kein Generalschlüssel

• eigene Dienstkonten mit knapp geschnittener Rolle empfohlen

• ausführliche Endpunkt-Dokumentation inklusive Postman-Sammlung

• ergänzt sich mit Webhooks für die Gegenrichtung und iCal für reine Anzeige