Se connecter en utilisant l'API
Comment se connecter à FAC via l'API
Il existe plusieurs points de terminaison API qui peuvent être utilisés pour la connexion. L'API de connexion décrite ici est /login. Il en existe d'autres, comme /auth/forceLogin, qui force la connexion en mettant fin à une ancienne session si l'utilisateur était déjà connecté.
Pour utiliser l'API Swagger, veillez à définir xserver.swagger.enable=true dans le fichier xserver.properties.
Pour créer une demande, créez un appel POST vers /login, comme https://my-address/login. Le corps JSON de l'appel doit ressembler à ceci :
{
"username":"myuser",
"password":"qwer1234",
"domain":"ubimax",
"agreedToTos":"true"
}
Ici, nous spécifions le nom d'utilisateur, le mot de passe et le domaine. Après avoir fait cela, nous pouvons exécuter la requête.
La réponse que nous recevrons ressemblera à ceci :
{
"token": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJGQ0MiLCJzdWIiOiJ0ZXN0ZXIiLCJkb21haW4iOiJ1YmltYXgiLCJpZCI6MTYyOTI4NDQ0ODg0OSwiaWF0IjoxNjI5Mjg0NDQ4LCJleHAiOjE2MjkyODQ3NDh9.9qhH0Jpf-xtzPa5Gu3CUt89dVag-8obzV-dNYsGojs_GNdfSfcM_iJ4rA01-Wg7Gr3LQfRkjtLhC95AHLmtc5A",
"refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJpc3MiOiJGQ0MiLCJzdWIiOiJ0ZXN0ZXIiLCJkb21haW4iOiJ1YmltYXgiLCJpYXQiOjE2MjkyODQ0NDgsImV4cCI6MTYyOTg4OTI0OH0.-L38U0FsXHhOJCxWus4kXEezSm6tcZ3u2nKzhZX9C_0ZqyRrscG7sDNWsP8gUREeNRrXpvA1YAUqamQRQb8_QA",
"permissions": [
"ROLE_adm_administration",
...
]
}
Pour les appels d'API suivants, nous pouvons maintenant utiliser le jeton que nous avons reçu comme jeton de porteur comme autorisation.
Pour obtenir un aperçu général des appels d'API disponibles, visitez https://my-address/admin.html#!/apis.
Tous les appels d'API y sont répertoriés avec les données dont ils ont besoin pour être exécutés et peuvent également être testés. Il s'agit de la description de l'API pour /login :
Nous voyons ici qu'un usernamePasswordLoginModel est attendu, qui est défini ci-dessous à titre d'exemple. Si nous remplissons le champ maintenant et exécutons la requête. Le résultat ressemble à ceci :
Le résultat montre l'URL à laquelle nous avons envoyé la requête et la commande curl.
