Wofür Zugriffstoken?
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:
- Öffne die Einstellungen.
- Navigiere zu dem Menüpunkt Dienstkonten.
- Klicke oben rechts auf den Erstellen-Button.
- Trage im Popup einen Anzeigenamen und optional eine Beschreibung ein.
Zugriffstoken erstellen
Mit den entsprechenden Berechtigungen kannst du in der Dienstkontenverwaltung für Dienstkonten Zugriffstokens erstellen:
- Öffne das gewünschte Dienstkonto.
- Klicke oben rechts auf den Button Zugriffstoken erstellen.
- Lege ein Ablaufdatum fest. Wenn du kein Ablaufdatum festlegst, läuft der Zugriffstoken erst ab, wenn du ihn löschst.
- Klicke anschließend unten rechts auf Speichern. Es wird dir nun EINMALIG ein Zugriffstoken angezeigt.
- Kopiere den einmalig angezeigten Zugriffstoken für deine API-Aufrufe an die Stelle, wo du ihn benötigst.
Wichtig: 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 den alten Token löschen und einen neuen Zugriffstoken für dasselbe Dienstkonto erstellen.
Denk daran, dass dieser Token Zugriff auf deinen Account gibt, um Änderungen per Schnittstelle durchzuführen. Wenn Unbefugte diesen Code besitzen, können sie auch auf deine Daten zugreifen und Änderungen vornehmen. Solltest du dir nicht sicher sein, ob Unberechtigte möglicherweise Zugriff auf deine Tokens hatten, lösche die fragwürdigen Tokens und erstelle neue! Denk in diesem Fall aber daran, anschließend alle API-Aufrufe auf das neue Token hin anzupassen, da die Schnittstellen-Integrationen sonst nicht mehr funktionieren.
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.