API-Zugang einrichten

Du brauchst einen API-Token, um externe Systeme mit weboffice digital zu verbinden – etwa um Daten automatisiert zu importieren oder Schnittstellen zu nutzen. Hier legst du einen neuen Token an und bestimmst, was er darf.

Voraussetzungen

Du benötigst Administratorrechte für weboffice digital.

Aufbau der Seite

Die Seite zeigt eine Übersicht aller vorhandenen API-Token mit ihren wichtigsten Eigenschaften:

• Bezeichnung: Der Name, unter dem du den Token wiedererkennst
• Präfix: Ein Kürzel, das vor jedem Token-Wert steht
• Berechtigungen: Welche Module und Funktionen dieser Token nutzen darf
• Ersteller: Wer hat den Token angelegt
• Gültig bis: Das Ablaufdatum

Oben findest du die Schaltfläche Token erstellen, um einen neuen Token hinzuzufügen.

So gehst du vor

1. Klicke auf Token erstellen. Ein Fenster öffnet sich mit den Einstellungen für einen neuen Token.

2. Trage eine Bezeichnung ein. Das ist dein Erkennungsmerkmal – wähle einen Namen, unter dem du später weißt, wofür dieser Token genutzt wird.

3. Wähle das Ablaufdatum unter Gültig bis. Der Token funktioniert nur bis zu diesem Datum. Danach musst du einen neuen Token erstellen. Das Feld ist vorausgefüllt und kann angepasst werden.

4. Wähle unter Berechtigungen aus, auf welche Module und Funktionen dieser Token Zugriff haben soll. Die Liste zeigt alle verfügbaren Bereiche – etwa Administration, Artikel, Kalender, Kunden, Dateien und viele mehr. Aktiviere nur die Berechtigungen, die du wirklich brauchst. Ein Token mit weniger Rechten ist sicherer.

5. Klicke auf Erstellen. Der Token wird gespeichert und dir angezeigt – notiere ihn dir sofort, denn du kannst ihn nachher nicht mehr einsehen. Wer diesen Token hat, kann damit auf dein System zugreifen.

6. Klicke auf Schließen, wenn du fertig bist. Der Token steht deinen externen Systemen jetzt zur Verfügung.

Was danach passiert

Der neue Token erscheint in der Übersicht. Externe Systeme können sich damit anmelden und auf die Funktionen zugreifen, die du ihnen freigegeben hast. Der Token läuft am eingestellten Datum ab – danach musst du einen neuen erstellen.

Willst du einen Token sperren oder ändern, bearbeitest du ihn direkt in der Übersicht oder löschst ihn.

Tipps und Hinweise

• Sicherheit: Teile Tokens nur mit vertrauenswürdigen Systemen und Personen. Ein Token ist wie ein Passwort – wer ihn hat, kann auf dein System zugreifen.
• Rechte beschränken: Gib dem Token nur die Berechtigungen, die er wirklich braucht. Wenn ein Import nur Artikel betrifft, aktiviere nur die Artikel-Berechtigung.
• Regelmäßig prüfen: Schau dir die Liste der aktiven Tokens regelmäßig an. Lösche Tokens, die du nicht mehr brauchst.
• Ablaufdatum beachten: Expired Tokens funktionieren plötzlich nicht mehr. Notiere dir, wann deine wichtigen Tokens ablaufen.