Skip to main content
Unter Verwaltung › API-Schlüssel verwalten Sie Anmeldedaten für externe Systeme, die auf Docusnap365 zugreifen.

​
Die Liste

Die Tabelle führt Name, Benutzer, Zugriff, Status und Ablauf.
Benutzer nennt den Besitzer des Schlüssels, nicht das technische Principal, unter dem ein Zugriff läuft. Die Rollen Besitzer und Administrator sehen dabei die Schlüssel aller Benutzer, nicht nur die eigenen.
Zugriff zeigt Lesen oder Lesen und Schreiben. Ein Gedankenstrich steht dort, wenn dem Besitzer des Schlüssels die Rolle entzogen wurde. Der Status nimmt einen von vier Werten an:
Ein Schlüssel mit dem Status Inaktiv funktioniert nicht mehr, obwohl ihn niemand gelöscht hat. Verwenden Sie für eine dauerhafte Anbindung deshalb kein Konto, das demnächst die Rolle verliert oder deaktiviert wird.
Läuft ab ist Ihr Vorlauf von 30 Tagen. Ein unbemerkt abgelaufener Schlüssel legt die angebundene Integration still. Verlängern Sie ihn rechtzeitig über API-Schlüssel neu generieren.

​
Anlegen und Bearbeiten

API-Schlüssel anlegen verlangt Name (nur Buchstaben ohne Umlaute, Ziffern und Bindestrich, eindeutig) und Ablauf (höchstens zwei Jahre in der Zukunft). Unter Zugriff wählen Sie Lesen („Daten über die REST-API nur lesen“) oder Lesen und Schreiben („Daten über die REST-API lesen, anlegen und bearbeiten“). Ein neuer Schlüssel ist mit Lesen vorbelegt.
Die Prüfung auf einen doppelten Namen läuft zunächst im Browser gegen die bereits geladenen Zeilen und kann einen Namen auf einer späteren Seite übersehen. Verbindlich meldet der Server beim Speichern „Name bereits vorhanden.”
Beim Bearbeiten schließt der Dialog ohne Aufruf, wenn Name, Zugriff und Ablauf unverändert sind.
Ein erfolgreiches Speichern meldet sich nicht eigens — das Schließen des Dialogs und die aktualisierte Zeile sind die Rückmeldung. Nur ein Fehler erscheint, und zwar im weiterhin geöffneten Dialog.
Ist das Nutzungslimit Speicher der Subscription überschritten, fehlen Anlegen, Bearbeiten, Neu generieren und Löschen. Die Liste bleibt lesbar.

​
Der Schlüssel im Klartext

Beim Anlegen und beim Neu-Generieren zeigt ein eigener Dialog den erzeugten API-Schlüssel im Klartext — ein einziges Mal. Die Liste selbst führt ihn nie. Kopieren Sie ihn in diesem Moment: Wer den Dialog schließt, ohne zu kopieren, kommt nur über API-Schlüssel neu generieren an einen neuen, und der alte gilt dann nicht mehr — jedes damit angebundene System verliert den Zugang.

​
API-Schlüssel neu generieren

API-Schlüssel neu generieren stellt einen neuen Schlüssel aus und fragt dabei das Datum Ablauf ab. Bei einem gültigen Schlüssel ist das bisherige Ablaufdatum vorbelegt; Sie können es dabei verlängern. Ein abgelaufener Schlüssel verlangt ein neues Ablaufdatum und wird damit verlängert und neu ausgestellt.
Der bisherige Schlüssel wird ungültig, sobald der neue ausgestellt ist. Hinterlegen Sie den neuen Schlüssel in jedem angebundenen System.
Scheitert nur das Ausstellen, ist ein geändertes Ablaufdatum bereits gespeichert. Die Zeile zeigt dann den neuen Ablauf, obwohl kein neuer Schlüssel entstanden ist.

​
Löschen

Löschen entfernt den Schlüssel endgültig; Zugriffe mit ihm schlagen danach fehl. Ein versehentlich gelöschter Schlüssel muss neu angelegt und auf der Gegenseite neu hinterlegt werden.
Für mehrere Schlüssel markieren Sie die Zeilen und verwenden Löschen in der Selektions-Leiste.
Scheitert dabei ein Teil, laufen die übrigen trotzdem durch; eine Zeile über der Tabelle nennt danach, wie viele von wie vielen nicht verarbeitet werden konnten, mit ihren Namen. Diese Zeile verschwindet nicht von selbst.

​
Weiterführend

Welche Rolle ein Benutzer trägt, beschreibt Benutzer und Rollen. Was sich über die Schnittstelle abrufen lässt, steht im Entwickler-Bereich.