Wie erstelle ich einen Zugriffstoken für einen API-Aufruf?

Wenn du die Vaira Schnittstelle benutzt, um Vorgänge zu erstellen, Daten darin auszufüllen oder Daten daraus abzurufen, müssen die Schnittstellenaufrufe authentifiziert und autorisiert sein. Dazu benötigst du Dienstkonten und Zugriffstoken.

Dienstkonten sind technische Benutzer, die in Vaira durch einen API-Aufruf (Application Programming Interface, zu Deutsch Schnittstellenaufruf) Aktionen mit Vorgängen durchführen. Damit die Dienstkonten über die API überhaupt erst angewiesen werden können, Aktionen durchzuführen, muss jeder dieser Aufrufe authentifiziert sein. Die Authentifizierung der Aufrufe erfolgt über Zugriffstokens.

Wenn der Aufruf authentifiziert ist, muss das Dienstkonto darüber hinaus autorisiert sein, die jeweilige Aktionen auszuführen. Die Autorisierung erfolgt über die Berechtigungsverwaltung im Vaira Office.

Dienstkonto erstellen

Mit den entsprechenden Berechtigungen kann in den Einstellungen ein Dienstkonto erstellt werden:

  1. Öffne die Einstellungen.
  2. Navigiere zu dem Menüpunkt Dienstkonten.
  3. Klicke auf Erstellen.
  4. Trage einen Namen und optional eine Beschreibung ein.

Zugriffstoken erstellen

Mit den entsprechenden Berechtigungen können in der Dienstkontenverwaltung für Dienstkonten  Zugriffstokens erstellt werden:

  1. Öffne das Dienstkonto.
  2. Klicke auf Zugriffstoken erstellen.
  3. Lege ein Ablaufdatum fest. Wenn du kein Ablaufdatum festlegst, läuft der Zugriffstoken erst ab, wenn du ihn löschst.
  4. Kopiere den einmalig angezeigten Zugriffstoken für deine API-Aufrufe.

Der Zugriffstoken wird dir aus Sicherheitsgründen nur einmal bei der Erstellung angezeigt. Wenn du ihn verlierst, kannst du ihn also nicht mehr einsehen. In diesem Fall kannst du einfach einen neuen Zugriffstoken für dasselbe Dienstkonto erstellen erstellen.

Dienstkonto-Berechtigungen zuweisen

Dienstkonten verhalten sich in der Berechtigungsverwaltung genau so wie Benutzer und Gruppen. Im Artikel zu Zugriffsrechten von Nutzern erfährst du mehr dazu.