Das Libraesva Email Security Gateway stellt eine Reihe von Application Programming Interfaces zur Verfügung.
Die APIs sind immer verfügbar. Die Liste aller verfügbaren APIs finden Sie innerhalb von ESG unter dem Pfad /api/v2/ nach der Authentifizierung.
Beispiel: demo.esvacloud.com/api/v2/
Sie können direkt über die Dokumentationsseite mit den APIs interagieren, indem Sie sich über die Schaltfläche „Authorize“ oben rechts auf der Seite authentifizieren. Diese Authentifizierung erfordert ein gültiges API Token.
Um ein API Token zu generieren, muss eine Anmeldung am Endpunkt /api/v2/login durchgeführt werden, der ein gültiges API Token zurückgibt, das für weitere API-Aufrufe verwendet werden kann.
Das generierte API Token übernimmt die Berechtigungen des Benutzers, der die Authentifizierung am /login-Endpunkt durchgeführt hat, sofern es sich um einen normalen Benutzer handelt (vorhanden in der Tabelle „User Management -> Users“).
Um nach der Anmeldung einen API-Aufruf durchzuführen, müssen Sie das API Token im Header „X-ESG-Auth-Token“ übergeben.
Wird die Authentifizierung mit einem API User durchgeführt („User Management -> API Users“), müssen Sie nach der anfänglichen /login-Anfrage zur Generierung des API Tokens einen ESG-Benutzer angeben, den Sie mit dem Header „X-Switch-User“ imitieren möchten.
In diesem Header müssen Sie den Benutzernamen des zu imitierenden ESG-Benutzers angeben. Der API User, der den Aufruf durchführt, übernimmt für diesen API-Aufruf die Berechtigungen des angegebenen Benutzers. Wird kein Benutzer angegeben, führt dies zu einem 403-Fehler, da der API User standardmäßig über keine Berechtigungen verfügt und ausschließlich den /login-Aufruf durchführen kann.
Nachfolgend sehen Sie die Header, die ausgefüllt werden müssen, wenn Sie auf die Schaltfläche „Authorize“ klicken, um API-Aufrufe direkt innerhalb von ESG durchzuführen.
