API-Zugang erstellen

Du erstellst hier einen API-Token, um weboffice digital von außen zu steuern – etwa um Daten zu synchronisieren oder automatisierte Prozesse anzubinden. Der Token enthält eine Bezeichnung, ein Verfallsdatum und eine Liste von Berechtigungen, die festlegen, welche Funktionen der API mit diesem Token möglich sind.

Voraussetzungen

Du brauchst das Recht zur Verwaltung von API-Zugängen in der Benutzergruppe.

So gehst du vor

1. Trage eine Bezeichnung ein, unter der du den Token später wiederfindest – etwa der Name der Anwendung oder des Systems, das weboffice digital nutzen soll.

2. Wähle ein Verfallsdatum (Feld "Gültig bis"). Nach diesem Datum funktioniert der Token nicht mehr. Das Feld ist vorbelegt und kann leer bleiben – dann läuft der Token nicht ab.

3. Setze Häkchen bei den Berechtigungen, die dieser Token haben soll. Jede Berechtigung entspricht einem Bereich oder einer Funktion in weboffice digital. Wähle nur die aus, die wirklich nötig sind – so minimierst du das Risiko, falls der Token in falsche Hände gerät. Du siehst hier etwa:

   • Web.Office.Administration
   • Web.Office.Article
   • Web.Office.Board
   • Web.Office.Calendar
   • Web.Office.CashPoint
   • Web.Office.Configuration
   • Web.Office.Customer
   • Web.Office.Dashboard
   • Web.Office.Expenses
   • Web.Office.Files
   • Web.Office.FormManagement
   • Web.Office.Gastro
   • Web.Office.GastroReservation
   • und viele weitere Bereiche

4. Klicke Erstellen, um den Token zu speichern. weboffice digital erzeugt daraufhin einen eindeutigen Code.

5. Kopiere den Token sofort – er wird dir danach nicht noch einmal angezeigt. Speichere ihn an einem sicheren Ort, etwa in einem Passwort-Manager. Verlierst du ihn, musst du einen neuen Token anlegen.

Was danach passiert

Der Token ist sofort einsatzbereit. Die externe Anwendung kann ihn nun verwenden, um sich bei der weboffice-API anzumelden. Der Token hat die Berechtigungen, die du ausgewählt hast – nicht mehr, nicht weniger.

Falls du einen Token vor seinem Verfallsdatum sperren möchtest, kannst du ihn aus der Liste der Tokens löschen. Das wirkt sofort.

Tipps und Hinweise

• Verbrauchter Token: Gibst du einen Token weiter oder teilst ihn mehreren Systemen, verlierst du die Kontrolle. Erstelle für jede Anwendung einen separaten Token.
• Berechtigung vergessen: Bekommst du später die Meldung "Berechtigung verweigert", war eine Berechtigung nicht gesetzt. Erstelle einen neuen Token mit der fehlenden Berechtigung und teile ihn der Anwendung mit.
• Sicherheit: Behandle einen API-Token wie ein Passwort. Gib ihn nie in Emails weiter, speichere ihn nicht im Code und füge ihn nicht in Versionskontrollsysteme ein.