Le Libraesva Email Security Gateway expose un ensemble d'Application Programming Interface.
Les APIs sont toujours disponibles, la liste de toutes les APIs disponibles se trouve dans ESG au chemin /api/v2/ après authentification.
Exemple : demo.esvacloud.com/api/v2/
Vous pouvez interagir avec les APIs directement depuis la page de documentation en vous authentifiant avec le bouton "Authorize" en haut à droite de la page, cette authentification nécessite un API Token valide.
Pour générer un API Token, une connexion doit être effectuée sur le point de terminaison /api/v2/login qui renverra un API Token valide pouvant être utilisé pour effectuer d'autres appels API.
L'API Token généré héritera des permissions de l'Utilisateur spécifié pour effectuer l'authentification sur le point de terminaison /login si c'est un Utilisateur normal (présent dans la table "User Management -> Users").
Pour effectuer un appel API après la connexion, vous devez transmettre l'API Token dans le "X-ESG-Auth-Token".
Si l'authentification est effectuée avec un API User ("User Management -> API Users"), après le /login initial pour générer l'API Token, vous devez spécifier un Utilisateur ESG à emprunter avec l'en-tête "X-Switch-User".
Dans cet en-tête, vous devez spécifier le nom d'utilisateur de l'Utilisateur ESG à emprunter, l'API User effectuant l'appel hérite des permissions de l'utilisateur spécifié pour cet appel API. Ne pas spécifier d'utilisateur entraînera une erreur 403, l'API User n'a aucune permission par défaut et ne peut effectuer que l'appel /login.
Ci-dessous, vous pouvez voir les en-têtes qui doivent être renseignés lorsque vous appuyez sur le bouton "Authorize" pour effectuer des appels API directement depuis ESG.
