Möchten Sie ein externes System mit der Lexeri API verbinden, wird ein sog. API-Token benötigt um die API-Anfrage zu authorisieren. API-Token fungieren ähnlich wie Zugangsdaten für externe Systeme.
Dieser Artikel enthält folgende Bereiche:
Erstellen eines API-Token
Um ein API-Token zu erstellen, gehen Sie in die Termdatenbank-Einstellungen und wechseln Sie hier auf den Reiter "API". Hier finden Sie den Button "API-Token erstellen":
Nach einem Klick auf den Button öffnet sich ein Dialog zum Erstellen eines API-Tokens. Hier können Sie dem Token einen Namen geben und eine Laufzeit des Tokens auswählen. Nach dieser Laufzeit läuft das Token automatisch ab und externe System, welches den API-Token nutzt, wird mit diesem Token keinen Zugriff mehr auf die Lexeri-API erhalten.
Außerdem können Sie auswählen, ob das API-Token dem externen System Schreibzugriff auf die Termdatenbank geben soll. Dies ist nur notwendig, wenn das System auch wie ein Terminologiemanager Änderungen an der Terminologie vornehmen können soll.
Nachdem Sie das Token erstellt haben, wird Ihnen das neue Token in Form einer langen Reihe von Buchstaben angezeigt. Klicken Sie auf den "Kopieren"-Button, um den Token in Ihre Zwischenablage zu kopieren.
Das Token wird Ihnen nach dem Schließen des Fensters nicht mehr angezeigt werden, daher kopieren Sie es unbedingt bevor Sie das Fenster schließen.
API-Token löschen
Erstellte API-Token können Nutzende mit der Rolle "Administrator" in den Einstellungen Ihrer Termdatenbank im Reiter "API" jederzeit löschen.
Klicken Sie hierzu auf das Mülleimer-Symbol in dem API-Token, welches Sie löschen möchten:
Externe Systeme, die das gelöschte API-Token verwenden, können danach nicht mehr auf die Lexeri API zugreifen.
Best Practices für den sicheren Umgang mit API-Token
API-Token bieten externen Systemen Zugriff auf Ihre Termdatenbank. Daher sollten API-Token wie Zugangsdaten betrachtet werden und mit Ihnen sorgsam umgegangen werden. Hier einige unserer Empfehlungen zu API-Token:
- Erstellen Sie für jedes externes System ein eigenes API-Token, damit Sie diese bei Bedarf separat sperren können
- Speichern Sie API-Tokens niemals in Quellcode oder öffentlich zugänglichen Dateien
- Beschränken Sie den Token-Zugang auf autorisierte Personen und Systeme
- Erneuern Sie API-Tokens in regelmäßigen Abständen (empfohlen: alle 3-6 Monate)
- Deaktivieren Sie ggf. kompromittierte Tokens umgehend