weboffice.digital - Dokumentation
Branche Beauty Branche Gastro Branche Handel
PDF

API-Zugriffe verwalten

API-Zugriffe verwalten

Ansicht dieser Seite

Hier erstellst und konfigurierst du Zugangstoken für externe Programme, die über die Programmierschnittstelle (API) auf weboffice zugreifen sollen. Jeder Token erhält eine Gültigkeitsdauer und nur die Berechtigungen, die er wirklich braucht.

Voraussetzungen

Du brauchst Administratorrechte für weboffice.

So gehst du vor

  1. Rufe den Bereich API-Tokens auf (im Verwaltungsmenü unter INTEGRATION).

  2. Klicke auf die grüne Schaltfläche Token erstellen.

  3. Ein Fenster öffnet sich. Trage unter Bezeichnung einen Namen ein, unter dem du diesen Token später wiederfindest – etwa der Name des Programms, das ihn nutzen soll.

  4. Unter Gültig bis wird automatisch ein Enddatum voreingestellt (26.07.2024). Ändere dieses Datum, wenn der Token früher oder später ablaufen soll. Nach diesem Datum funktioniert der Token nicht mehr.

  5. Wähle unter Berechtigungen alle Funktionsbereiche an, auf die das externe Programm zugreifen darf. Die verfügbaren Berechtigungen richten sich danach, welche Module in deinem weboffice freigeschaltet sind – etwa Web.Office.Article für Artikelverwaltung oder Web.Office.Customer für Kundendaten. Wähle nur die Berechtigungen aus, die das Programm wirklich benötigt.

  6. Klicke auf die grüne Schaltfläche Erstellen unten rechts.

  7. weboffice erzeugt den Token und zeigt ihn dir genau einmal an. Kopiere ihn sofort und speichere ihn sicher ab – danach kannst du ihn nicht mehr abrufen. Wenn du ihn verlierst, musst du einen neuen Token erstellen.

  8. Klicke auf Schließen, um das Fenster zu verlassen.

Aufbau der Seite

Die Tabelle zeigt alle bisherigen Token mit ihren Spalten:

  • Bezeichnung: Der Name, den du beim Erstellen eingegeben hast
  • Präfix: Ein Kurzkürzel, das weboffice dem Token automatisch voranstellt – brauchst du normalerweise nicht
  • Berechtigungen: Welche Funktionsbereiche dieser Token nutzen darf
  • Ersteller: Wer diesen Token erzeugt hat
  • Erstellung: Das Datum, an dem der Token angelegt wurde

Was danach passiert

Der neue Token ist sofort aktiv. Du kannst ihn dem externen Programm mitgeben, das ihn dann zur Anmeldung an der API nutzt. Der Token wird in der Liste gespeichert und bleibt so lange gültig, bis das Enddatum abgelaufen ist.

Tipps und Hinweise

  • Token sicher aufbewahren: Ein Token funktioniert wie ein Passwort. Behandle ihn vertraulich und gib ihn nicht an Unbefugte weiter.
  • Nur nötige Berechtigungen: Je weniger Berechtigungen ein Token erhält, desto kleiner ist der Schaden, falls er in falsche Hände gerät.
  • Abgelaufene Token: Sobald das Enddatum überschritten ist, funktioniert der Token nicht mehr. Erstelle rechtzeitig einen neuen, wenn das Programm weiterhin Zugriff braucht.
  • Token löschen: Wenn ein Programm keinen Zugriff mehr braucht, lösche seinen Token aus der Liste.

Suche