Wann steht mir die Public API zur Verfügung?
Um die Public API zu nutzen, benötigen Sie die lexoffice Version XL.
Wo finde ich die Public API und die API-Schlüssel Verwaltung?
Die Public API finden Sie in unseren Erweiterungen unter "Weitere Apps".
Um einen Public API-Schlüssel zu generieren, wechseln Sie in die Public API Verwaltung Ihres lexoffice Accounts: https://app.lexoffice.de/addons/public-api
Wie lege ich einen Public API-Schlüssel an?
Klicken Sie auf den grünen Button "API-Schlüssel erstellen" in der Public API Verwaltung.
Nun öffnet sich das Fenster “Neuen API-Schlüssel erstellen”.
Berechtigungen des Public API-Schlüssel festlegen
Option 1) Schlüssel mit allen Berechtigungen:
Mit dieser Option wird ein API-Schlüssel mit Zugriff auf alle Public API Endpunkte und allen zum Erstelldatum verfügbaren Funktionen erstellt. Damit steht der via Public API angebundenen Software der volle Funktionsumfang der lexoffice Public API zur Verfügung.
Mit Klick auf “WEITER” wird die Bezeichnung des anzulegenden API-Schlüssels abgefragt. Tragen Sie hier z.B. den Namen der angebundenen Software ein.
Mit Klick auf "API-Schlüssel erstellen" wird Ihr individueller API-Schlüssel generiert.
Achtung: Schließen Sie das Fenster erst, wenn Sie den API-Schlüssel kopiert haben. Dieser kann nicht erneut angezeigt werden.
Nun wird der erstellte Public API-Schlüssel in der Übersicht angezeigt.
Option 2) Schlüssel mit individuellen Berechtigungen:
Diese Option bietet die Möglichkeit, die Berechtigungen des angelegten API-Schlüssels detailliert zu definieren. Diese Option sollte gewählt werden, wenn der Funktionsumfang der angebundenen Software genau bekannt ist und Sie über das erforderliche Fachwissen verfügen.
Ein API-Schlüssel mit individueller Berechtigung stellt sicher, dass die per Public API angebundene Software keinen Zugriff auf anderweitige Daten erhält.
👉 Ein Beispiel: Eine per Public API angebundene Software soll Ausgangsrechnungen und die Rechnungsempfänger anlegen.
Hierzu benötigt die Public API lesenden und schreibenden Zugriff auf Kontakte und Rechnungen.
Mit Klick auf “WEITER” wird die getroffene Auswahl nochmals angezeigt und die Bezeichnung des anzulegenden API-Schlüssels abgefragt. Tragen Sie als Bezeichnung z.B. den Namen der angebundenen Software ein.
Auch können Sie hier nochmals die vergebenen Berechtigungen kontrollieren.
Mit Klick auf "API-Schlüssel erstellen" wird Ihr individueller API-Schlüssel generiert.
Achtung: Schließen Sie das Fenster erst, wenn Sie den API-Schlüssel kopiert haben. Dieser kann nicht erneut angezeigt werden.
Abschließend wird ein Public API-Schlüssel mit den individuellen Berechtigungen angelegt und in der Übersicht angezeigt.
Können mehrere Public API-Schlüssel angelegt werden?
Es ist möglich mehrere Public API-Schlüssel anzulegen.
Warum haben die Public API-Schlüssel ein Ablaufdatum?
Aus Sicherheitsgründen ist die Gültigkeitsdauer der lexoffice Public API-Schlüssel auf maximal 24 Monate begrenzt. Mit Erreichen des angezeigten Ablaufdatums werden Public API-Schlüssel automatisch deaktiviert und gelöscht.
Können API-Schlüssel gelöscht werden?
In der Public API Verwaltung können Schlüssel mit Klick auf das “Mülleimer Icon” gelöscht werden. Gelöschte Schlüssel können nicht wieder hergestellt werden.
Was ist zu tun, wenn die Gültigkeit eines Public API-Schlüssels bald abläuft?
Es ist möglich, Public API-Schlüssel durch Klick auf das Refresh-Icon zu kopieren oder das Ablaufdatum manuell zu verlängern.
Wählen Sie die Option kopieren, wenn der bestehende API-Schlüssel durch einen neuen API-Schlüssel ersetzt werden soll.
Ergebnis einer Kopie ist ein neuer Schlüssel mit den Berechtigungen seines Vorgängers. Der Vorgänger Schlüssel bleibt erhalten und funktionstüchtig, bis sein Ablaufdatum erreicht ist. Der Vorgänger-Schlüssel kann nun in der angebundenen Software durch den neu angelegten API-Schlüssel ersetzt werden.
Mit der Option verlängern kann die Gültigkeitsdauer von API-Schlüsseln verlängert werden. Ergebnis einer Verlängerung ist die Verlängerung des Ablaufdatums um 24 Monate.
Da der API-Schlüssel bis auf das Ablaufdatum nicht verändert wird, ist es nicht erforderlich, den API-Schlüssel in der angebundenen Software zu ersetzen.
Sind die Berechtigungen einzelner API-Schlüssel einsehbar?
Durch Klick auf den Pfeil vor der API-Schlüssel Bezeichnung werden die Berechtigungen des API-Schlüssels dargestellt.
Können die Berechtigungen von API-Schlüsseln nachträglich verändert werden?
Es ist nicht möglich, die Berechtigungen nachträglich zu ändern. Legen Sie in dem Fall einen neuen Public API-Schlüssel mit den passenden Berechtigungen an.
Stichworte: API-Key, Token, Drittsystem anbinden