Comment utiliser les appels API du Login Widget SDK

Vous pouvez utiliser les appels API du Login Widget SDK séparément du widget Login si vous souhaitez :

  • utiliser votre propre design de widget ;
  • implémenter partiellement le flux du widget Login.

Note
Ce ne sont pas tous les appels API qui prennent en charge ce scénario.

Initialisation du code

Pour utiliser les appels API du Login Widget SDK sans widget, connectez le code suivant à la balise <body> :

Copy
Full screen
Small screen
1<script>
2const api = new XsollaLogin.Api({
3  projectId: 'someProjectId'
4});
5</script>

Code d’initialisation lors de l’utilisation d’un npm-package :

Copy
Full screen
Small screen
1import XsollaLogin from '@xsolla/login-sdk';
2const api = new XsollaLogin.Api({
3  projectId: 'someProjectId'
4});

Les paramètres suivants sont passés dans le code d’initialisation :

ParamètreTypeDescription
projectId
stringID de votre projet de connexion issu du Compte éditeur. Obligatoire.
fullLocale
stringLangue d’interface et région au format <language code>_<country code>, où :Les langues suivantes sont prises en charge : arabe (ar_AE), bulgare (bg_BG), tchèque (cs_CZ), allemand (de_DE), anglais (en_XX), espagnol (es_ES), filipino (fil_PH), français (fr_FR), hébreu (he_IL), indonésien (id_ID), italien (it_IT), japonais (ja_JP), khmer (km_KH), coréen (ko_KR), lao (lo_LA), myanmar (my_MM), népali (ne_NP), polonais (pl_PL), portugais (pt_BR), roumain (ro_RO), russe (ru_RU), thaï (th_TH), turc (tr_TR), vietnamien (vi_VN), chinois simplifié (zh_CN), chinois traditionnel (zh_TW).
Ce paramètre affecte le tri des réseaux sociaux en fonction de leur fréquence d’utilisation dans la région spécifiée et affecte également la langue utilisée pour les e-mails envoyés aux utilisateurs.
callbackUrl
stringURL avec laquelle le serveur Xsolla Login travaille si la connexion ou l’inscription est réussie.
emailTemplate
stringNom du projet au nom duquel les e-mails sont envoyés aux utilisateurs.
payload
stringDonnées supplémentaires pouvant être passées dans un code. Ces données sont ajoutées au JWT utilisateur après une connexion réussie.
with_logout
booleanRévoquer ou non les jetons précédents lors d’une nouvelle connexion. La valeur par défaut est false.
clientId
stringID de l’application cliente. Passé si l’authentification basée sur le protocole OAuth 2.0 est utilisée dans l’application.
scope
stringInformations supplémentaires sur un compte utilisateur demandées par l’application. Passées si l’application utilise l’authentification basée sur le protocole OAuth 2.0. Valeurs possibles :
  • email — requête supplémentaire d’adresse e-mail utilisateur lors de la connexion via les réseaux sociaux.
  • offline — mise à jour automatique du JWT après son expiration.
  • playfab — le paramètre SessionTicket est automatiquement passé au JWT si le stockage des données utilisateur est PlayFab.
Vous pouvez également spécifier vos propres paramètres. Le serveur Xsolla Login ne les traite pas, mais les renvoie au JWT.
phase
stringUne vérification supplémentaire de l’utilisateur, par exemple, pour prévenir les attaques CSRF. Le mot de passe doit comporter plus de 8 caractères.
redirectUrl
stringURL vers laquelle l’utilisateur est redirigé après la confirmation du compte, la connexion ou la confirmation de la réinitialisation du mot de passe.
booleanDésactiver ou non la confirmation de l’authentification sans mot de passe par un lien dans un e-mail lorsque l’utilisateur se connecte sans mot de passe par adresse e-mail ou par numéro de téléphone. La valeur par défaut est false.
is_oauth2
booleanDétermine l’utilisation de l’authentification basée sur le protocole OAuth 2.0 pour les utilisateurs. La valeur par défaut est false.

Appels API

Vous pouvez utiliser les appels API du Login Widget SDK suivants sans le widget Login :

Enregistrement utilisateur par mot de passe

AppelDescriptionParamètres
api.signup(userInfo) ;Enregistre un nouvel utilisateur. Les données utilisateur sont passées dans l’objet userInfo lors de l’enregistrement. Le jeton de l’utilisateur enregistré est passé dans la réponse.
  • email (string) — adresse e-mail de l’utilisateur. Obligatoire.
  • username (string) — nom d’utilisateur. Obligatoire.
  • password (string) — mot de passe de l’utilisateur. Obligatoire.
  • nickname (string) — Pseudo de l’utilisateur.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api.signup({
 4  userInfo: {
 5    email: 'email@address.com',
 6    fields: {
 7      nickname: 'Johny'
 8    },
 9    password: 'password123',
10    username: 'John'
11  }
12}).then((res) => {
13  result = res;
14})
15
16// Response
17result === {
18  login_url: 'https://someurl.com?token=XXXXXXX'
19}

Connexion avec mot de passe

AppelDescriptionParamètres
api.login(credentials) ;Authentifie l’utilisateur par mot de passe. Les données sur l’utilisateur requises pour la connexion sont passées dans l’objet credentials. Le jeton de l’utilisateur authentifié est passé dans la réponse.
  • username (string) — nom d’utilisateur, par exemple, John ; ou adresse e-mail, par exemple, email@address.com. Obligatoire.
  • password (string) — mot de passe de l’utilisateur. Obligatoire.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api.login({
 4  credentials: {
 5    password: 'password123',
 6    username: 'email@address.com'
 7  }
 8}).then((res) => {
 9  result = res;
10})
11
12// Response
13result === {
14  login_url: 'https://someurl.com?token=XXXXXXX'
15}
16
17// Response with additional fields
18result === {
19  ask_fields: [{
20    confirmation_type: 'code' || 'link'
21    name: 'phone_number'
22    required: false
23    step: 0 // Displays the position of the field in the data retrieval queue.
24    type: 'phone'
25    validation: {} // Custom validation
26  }]
27  login_url: 'https://someurl.com?token=XXXXXXX',
28  token: 'sometoken'
29}

Confirmation du compte

AppelDescriptionParamètres
api.resendEmail(username) ;Envoie un e-mail supplémentaire de confirmation du compte. Pour confirmer le compte, l’utilisateur doit cliquer sur le lien contenu dans l’e-mail. L’adresse e-mail de l’utilisateur est passée dans l’objet username. Le code standard 204 est renvoyé dans la réponse.
  • username (string) — adresse e-mail de l’utilisateur, par exemple : email@address.com. Obligatoire.
Exemple :
Copy
Full screen
Small screen
1// Request
2api.resendEmail({
3  username: "email@address.com"
4}).then((res) => {
5  if (res.code === 204) {
6    console.log("Email resend success");
7  }
8});

Authentification sans mot de passe

Flux utilisateur :

  1. L’utilisateur saisit son numéro de téléphone ou son adresse e-mail. En fonction des informations d’identification qu’il a saisies, l’appelapi.phoneGetCode ou api.emailGetCode est exécuté.
  2. Le serveur reçoit les données et envoie un e-mail ou un SMS contenant le code à l’utilisateur. Si le paramètre disableConfirmByLink=true, qui désactive la confirmation de connexion par le lien dans un e-mail, est passé lors de l’initialisation du code, l’appel api.getConfirmCode est utilisé pour la redirection automatique de l’utilisateur après un clic sur le lien.
  3. L’appel api.phoneGetCode ou api.emailGetCode renvoie le paramètre operation_id utilisé pour confirmer le numéro de téléphone ou l’adresse e-mail par le biais de l’appel api.loginWithPhoneCode ou api.loginWithEmailCode.
  4. Une fois l’adresse e-mail ou le numéro de téléphone confirmé avec succès, l’URL avec le paramètre token est renvoyée. Il est utilisé dans les requêtes de données supplémentaires sur l’utilisateur.

AppelDescriptionParamètres
api.phoneGetCode({ phone_number, link_url, isOauth2 }) ;Envoie un code de confirmation au numéro de téléphone. Le paramètre operation_id utilisé pour confirmer le numéro de téléphone est renvoyé dans la réponse.
  • phone_number (string) — numéro de téléphone pour l’authentification sans mot de passe.
  • link_url (string) — URL de confirmation.
  • isOauth2 (boolean) — détermine l’utilisation de l’authentification basée sur le protocole OAuth 2.0 pour les utilisateurs. Obligatoire.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api.phoneGetCode({
 4  phone_number: '+somenumber',
 5  link_url: 'https://someurl.com',
 6  isOauth2: true
 7}).then((res) => {
 8  result = res;
 9})
10
11// Response
12result === {
13  operation_id: '2334j255fdf13d515fgd1'
14}
AppelDescriptionParamètres
api.phoneGetCode({ phone_number, link_url, isOauth2 }) ;Envoie un code de confirmation à l’adresse e-mail. Le paramètre operation_id utilisé pour confirmer l’adresse e-mail est renvoyé dans la réponse.
  • email (string) — adresse e-mail pour l’authentification sans mot de passe.
  • link_url (string) — URL de confirmation.
  • isOauth2 (boolean) — détermine l’utilisation de l’authentification basée sur le protocole OAuth 2.0 pour les utilisateurs. Obligatoire.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api.emailGetCode({
 4  email: 'email@address.com',
 5  link_url: 'https://someurl.com',
 6  isOauth2: true
 7}).then((res) => {
 8  result = res;
 9})
10
11// Response
12result === {
13  operation_id: '2334j255fdf13d515fgd1'
14}
AppelDescriptionParamètres
api.getConfirmCode({ cancelToken, login, operation_id }) ;Récupère le code de confirmation pour une redirection automatique de l’utilisateur après un clic sur le lien.
  • cancelToken (string) — jeton unique permettant de mettre fin à la session. Obligatoire.
  • login (string) — numéro de téléphone ou adresse e-mail de l’utilisateur. Obligatoire.
  • operation_id (string) — identifiant unique utilisé pour confirmer le numéro de téléphone ou l’adresse e-mail de l’utilisateur au cours d’une session. Obligatoire.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3const axiosCancelToken = Axios.CancelToken.source();
 4
 5api.getConfirmCode({
 6  cancelToken: axiosCancelToken,
 7  login: '+somenumber' || 'email@address.com',
 8  operation_id: '334j255fdf13d515fgd1'
 9}).then((res) => {
10  result = res;
11})
12
13// Response
14result === {
15  code: 'string'
16}
17
18// If the waiting time has elapsed, returns:
19result === {
20  error: {
21    code: '010-050',
22    description: 'Deadline exceeded.'
23  }
24}
25
26// If you no longer need to wait for verification through the link you can close the request waiting period:
27axiosCancelToken.cancel();
AppelDescriptionParamètres
api.loginWithPhoneCode({ phone_number, code, operation_id, isOauth2 }) ;Confirme le numéro de téléphone. L’URL avec le paramètre token est renvoyée dans la réponse. Elle est utilisée dans les requêtes de données supplémentaires sur l’utilisateur.
  • phone_number (string) — numéro de téléphone pour l’authentification sans mot de passe.
  • code (string) — code de confirmation de numéro de téléphone envoyé par SMS.
  • operation_id (string) — identifiant unique utilisé pour confirmer le numéro de téléphone de l’utilisateur pendant la session en cours.
  • isOauth2 (boolean) — détermine l’utilisation de l’authentification basée sur le protocole OAuth 2.0 pour les utilisateurs. Obligatoire.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api.loginWithPhoneCode({
 4  phone_number: 'email@address.com',
 5  code: '3423',
 6  operation_id: '334j255fdf13d515fgd1',
 7  isOauth2: true
 8}).then((res) => {
 9  result = res;
10})
11
12// Response
13result === {
14  login_url: 'https://someurl.com?token=XXXXXXX'
15}
16
17
18// Response with additional fields
19result === {
20  ask_fields: [{
21    confirmation_type: 'code' || 'link'
22    name: 'email'
23    required: false
24    step: 0 // Displays the position of the field in the data retrieval queue.
25    type: 'email'
26    validation: {} // Custom validation
27  }]
28  login_url: 'https://someurl.com?token=XXXXXXX',
29  token: 'sometoken'
30}
AppelDescriptionParamètres
api.loginWithEmailCode({ email, code, operation_id, isOauth2 }) ;Confirme l’adresse e-mail. L’URL avec le paramètre token est renvoyée dans la réponse. Elle est utilisée dans les requêtes de données supplémentaires sur l’utilisateur.
  • email (string) — adresse e-mail pour l’authentification sans mot de passe.
  • code (string) — code de confirmation d’adresse e-mail envoyé par e-mail.
  • operation_id (string) — identifiant unique utilisé pour confirmer l’adresse e-mail de l’utilisateur pendant la session en cours.
  • isOauth2 (boolean) — détermine l’utilisation de l’authentification basée sur le protocole OAuth 2.0 pour les utilisateurs. Obligatoire.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api.loginWithEmailCode({
 4  email: 'email@address.com',
 5  code: '3423',
 6  operation_id: '334j255fdf13d515fgd1',
 7  isOauth2: true
 8}).then((res) => {
 9  result = res;
10})
11
12// Response
13result === {
14  login_url: 'https://someurl.com?token=XXXXXXX'
15}
16
17// Response with additional fields
18result === {
19  ask_fields: [{
20    confirmation_type: 'code' || 'link'
21    name: 'phone_number'
22    required: false
23    step: 0 // Displays the position of the field in the data retrieval queue.
24    type: 'phone'
25    validation: {} // Custom validation
26  }]
27  login_url: 'https://someurl.com?token=XXXXXXX',
28  token: 'sometoken'
29}

Demande de champs supplémentaires sans mot de passe

Flux utilisateur :

  1. Après l’authentification réussie de l’utilisateur, l’appel api.loginWithEmailCode ou api.loginWithPhoneCode renvoie un tableau de champs que vous pouvez afficher dans l’application dans un formulaire séparé et recueillir des informations telles que le numéro de téléphone et l’adresse e-mail de l’utilisateur. Pour obtenir la liste des champs, exécutez l’appel api.getAskFields.
  2. L’utilisateur saisit un numéro de téléphone ou une adresse e-mail. L’appel api.ask est exécuté.
  3. Le serveur reçoit les données et envoie un code de confirmation au numéro de téléphone ou l’adresse e-mail. Si le paramètre disableConfirmByLink=true, qui désactive la confirmation de connexion par le biais d’un lien dans l’e-mail, est passé lors de l’initialisation du code, l’appel api.getConfirmCode est utilisé pour la redirection automatique de l’utilisateur après un clic sur le lien.
  4. L’appel api.ask renvoie le paramètre operation_id utilisé pour confirmer le numéro de téléphone ou l’adresse e-mail par le biais de l’appel api.loginWithPhoneCode ou api.loginWithEmailCode.
  5. L’URL utilisée pour la redirection vers un utilisateur authentifié est renvoyée après la confirmation réussie des données.

AppelDescriptionParamètres
api.getAskFields(token) ;Récupère la liste des champs pour une requête supplémentaire.
  • token (string) — JWT utilisateur. Obligatoire.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api.getAskFields({
 4  token: 'sometoken'
 5}).then((res) => {
 6  result = res;
 7})
 8
 9// Response
10result === [
11  {
12    confirmation_type: 'code' || 'link'
13    name: 'phone_number' || 'email'
14    required: false
15    step: 0 // Displays the position of the field in the data retrieval queue.
16    type: 'phone' || 'email'
17    validation: {} // Custom validation
18  }
19]
AppelDescriptionParamètres
api.ask({ fields, token, link_url }) ;Envoie des données supplémentaires sur l’utilisateur : numéro de téléphone ou adresse e-mail. Le paramètre operation_id, utilisé pour confirmer le numéro de téléphone ou l’adresse e-mail spécifié, est renvoyé dans la réponse. Si la confirmation n’est pas nécessaire, l’URL avec le paramètre token, utilisé pour la redirection vers un utilisateur authentifié, est renvoyée dans la réponse.
  • fields (objet) — objet dans lequel le numéro de téléphone ou l’adresse e-mail de l’utilisateur est passé. Obligatoire.
  • token (string) — JWT utilisateur. Obligatoire.
  • link_url (string) — URL de confirmation.
Exemple d’envoi de numéro de téléphone :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api.ask({
 4  fields: {  
 5    phone_number: '+somenumber'
 6  },
 7  link_url: 'https://someurl.com',
 8  token: 'sometoken'
 9}).then((res) => {
10  result = res;
11})
12
13// Response
14result === {
15  error: {
16    code: '003-014'
17    description: 'Confirm phone number.'
18    details: { operation_id: 'BPaBScLM44GesoOYSxT5I8QfgIrTSURd' }
19  }
20}
21
22// Response without confirmation
23result === {
24  redirect_url: '<login_url>?token=<token>'
25}

Exemple d’envoi d’adresse e-mail :

Copy
Full screen
Small screen
 1let result
 2// request
 3api.ask({
 4  fields: {  
 5    email: 'email@address.com'
 6  },
 7  link_url: 'https://someurl.com',
 8  token: 'sometoken'
 9}).then((res) => {
10  result = res;
11})
12
13// Response
14result === {
15  error: {
16    code: '003-011'
17    description: 'Confirm email.'
18    details: { operation_id: 'BPaBScLM44GesoOYSxT5I8QfgIrTSURd' }
19  }
20}
21
22// Response without confirmation
23result === {
24  redirect_url: '<login_url>?token=<token>'
25}
AppelDescriptionParamètres
api.getConfirmCode({ cancelToken, login, operation_id }) ;Récupère le code de confirmation pour une redirection automatique de l’utilisateur après un clic sur le lien.
  • cancelToken (string) — jeton unique permettant de mettre fin à la session. Obligatoire.
  • login (string) — numéro de téléphone ou adresse e-mail de l’utilisateur. Obligatoire.
  • operation_id (string) — identifiant unique utilisé pour confirmer le numéro de téléphone ou l’adresse e-mail de l’utilisateur au cours d’une session. Obligatoire.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3const axiosCancelToken = Axios.CancelToken.source();
 4
 5api.getConfirmCode({
 6  cancelToken: axiosCancelToken,
 7  login: '+somenumber' || 'email@address.com',
 8  operation_id: '334j255fdf13d515fgd1'
 9}).then((res) => {
10  result = res;
11})
12
13// Response
14result === {
15  code: 'string'
16}
17
18// If the waiting time has elapsed, returns:
19result === {
20  error: {
21    code: '010-050',
22    description: 'Deadline exceeded.'
23  }
24}
25
26// If you no longer need to wait for verification through the link you can close the request waiting period:
27axiosCancelToken.cancel();
AppelDescriptionParamètres
api.loginWithPhoneCode({ phone_number, code, operation_id, isOauth2 }) ;Confirme le numéro de téléphone. L’URL avec le paramètre token est renvoyée dans la réponse. Elle est utilisée dans les requêtes de données supplémentaires sur l’utilisateur.
  • phone_number (string) — numéro de téléphone pour l’authentification sans mot de passe.
  • code (string) — code de confirmation de numéro de téléphone envoyé par SMS.
  • operation_id (string) — identifiant unique utilisé pour confirmer le numéro de téléphone de l’utilisateur pendant la session en cours.
  • isOauth2 (boolean) — détermine l’utilisation de l’authentification basée sur le protocole OAuth 2.0 pour les utilisateurs. Obligatoire.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api.loginWithPhoneCode({
 4  phone_number: 'email@address.com',
 5  code: '3423',
 6  operation_id: '334j255fdf13d515fgd1',
 7  isOauth2: true
 8}).then((res) => {
 9  result = res;
10})
11
12// Response
13result === {
14  login_url: 'https://someurl.com?token=XXXXXXX'
15}
16
17
18// Response with additional fields
19result === {
20  ask_fields: [{
21    confirmation_type: 'code' || 'link'
22    name: 'email'
23    required: false
24    step: 0 // Displays the position of the field in the data retrieval queue.
25    type: 'email'
26    validation: {} // Custom validation
27  }]
28  login_url: 'https://someurl.com?token=XXXXXXX',
29  token: 'sometoken'
30}
AppelDescriptionParamètres
api.loginWithEmailCode({ email, code, operation_id, isOauth2 }) ;Confirme l’adresse e-mail. L’URL avec le paramètre token est renvoyée dans la réponse. Elle est utilisée dans les requêtes de données supplémentaires sur l’utilisateur.
  • email (string) — adresse e-mail pour l’authentification sans mot de passe.
  • code (string) — code de confirmation d’adresse e-mail envoyé par e-mail.
  • operation_id (string) — identifiant unique utilisé pour confirmer l’adresse e-mail de l’utilisateur pendant la session en cours.
  • isOauth2 (boolean) — détermine l’utilisation de l’authentification basée sur le protocole OAuth 2.0 pour les utilisateurs. Obligatoire.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api.loginWithEmailCode({
 4  email: 'email@address.com',
 5  code: '3423',
 6  operation_id: '334j255fdf13d515fgd1',
 7  isOauth2: true
 8}).then((res) => {
 9  result = res;
10})
11
12// Response
13result === {
14  login_url: 'https://someurl.com?token=XXXXXXX'
15}
16
17// Response with additional fields
18result === {
19  ask_fields: [{
20    confirmation_type: 'code' || 'link'
21    name: 'phone_number'
22    required: false
23    step: 0 // Displays the position of the field in the data retrieval queue.
24    type: 'phone'
25    validation: {} // Custom validation
26  }]
27  login_url: 'https://someurl.com?token=XXXXXXX',
28  token: 'sometoken'
29}

Réinitialisation du mot de passe

Flux utilisateur :

  1. L’application ouvre le formulaire dans lequel l’utilisateur saisit son adresse e-mail ou son nom d’utilisateur. L’appel api.reset est exécuté.
  2. Le serveur envoie un e-mail de confirmation à l’utilisateur.
  3. L’utilisateur clique sur le lien contenu dans l’e-mail et ouvre le formulaire de nouveau mot de passe.
  4. L’utilisateur saisit un nouveau mot de passe. L’appel api.set est exécuté.

AppelDescriptionParamètres
api.reset(username) ;Réinitialise le mot de passe et confirme l’action. Pour confirmer la réinitialisation du mot de passe, l’utilisateur doit cliquer sur le lien contenu dans l’e-mail. Le nom d’utilisateur ou l’adresse e-mail de l’utilisateur est passé dans l’objet username. Le code 204 est renvoyé dans la réponse.
  • username (string) — nom d’utilisateur, par exemple, John ; ou adresse e-mail, par exemple, email@address.com. Obligatoire.
Exemple :
Copy
Full screen
Small screen
1let result
2// Request
3api.reset({
4  username: 'John'
5}).then((res) => {
6  res.code === 204;
7})
AppelDescriptionParamètres
api.set({ new_password, reset_code, user_id }) ;Définit le nouveau mot de passe et confirme l’action. Pour confirmer le nouveau mot de passe, l’utilisateur doit cliquer sur le lien contenu dans l’e-mail. Le code 204 est renvoyé dans la réponse.
  • new_password (string) — nouveau mot de passe saisi par le utilisateur. Obligatoire.
  • reset_code (string) — code utilisé pour la vérification de l’utilisateur qui a envoyé une demande de changement de mot de passe. Le code est généré côté serveur et est passé dans l’URL vers laquelle l’utilisateur est redirigé après un clic sur le lien dans l’e-mail. Obligatoire.
  • user_id (string) — identifiant de l’utilisateur. Il est généré côté serveur et est passé à l’URL vers laquelle l’utilisateur est redirigé après un clic sur le lien dans l’e-mail. Obligatoire.
Exemple :
Copy
Full screen
Small screen
1let result
2// Request
3api.set({
4  new_password: 'newpass',
5  reset_code: '3423',
6  user_id: '324324234'
7}).then((res) => {
8  res.code === 204;
9})

Authentification unique

ParamètreTypeDescription
api.checkUserAuthSSO() ;
Vérifie si l’utilisateur a été autorisé via l’authentification unique. En cas de succès, un message unique code est renvoyé.
Exemple :
Copy
Full screen
Small screen
 1let result
 2// Request
 3api
 4  .checkUserAuthSSO()
 5  .then(res => {
 6    result === res;
 7  });
 8
 9result === {
10  code: "examplecode"
11}
AppelDescriptionParamètres
api.userAuthSSOWithRedirect(loginUrl) ;Vérifie si l’utilisateur a été autorisé via l’authentification unique. En cas de succès, l’utilisateur est redirigé vers l’URL loginUrl générée avec un code d’autorisation.
  • loginUrl (string) — URL vers laquelle l’utilisateur est redirigé après une vérification SSO. Elle doit être identique à l’URL de rappel indiquée dans le bloc URL dans le Compte éditeur dans votre projet de connexion > General settings. Requise lorsqu’il existe plusieurs adresses URL vers lesquelles l’utilisateur peut être redirigé.
Exemple :
Copy
Full screen
Small screen
1// Request
2api
3  .userAuthSSOWithRedirect(
4    loginUrl: 'some-redirect-url.com'
5  )
6  .then(res => {
7    res.code === 302;
8  });
AppelDescriptionParamètres
api.logout(token, session) ;Déconnecte l’utilisateur du système et supprime la session utilisateur conformément au paramètre session.
  • token (string) —JWT utilisateur. Obligatoire.
  • session (string) — indique comment l’utilisateur se déconnecte du système et comment sa session est supprimée. Obligatoire.Valeurs possibles :
    • sso — supprime uniquement la session SSO de l’utilisateur.
    • all — supprime la session SSO de l’utilisateur ainsi que tous les jetons d’accès et les mises à jour.
Exemple :
Copy
Full screen
Small screen
1// Request
2api
3  .logout(
4    token: 'exampleToken',
5    session: 'sso' | 'all'
6  )
7  .then(res => {
8    res.code === 204;
9  });
ParamètreTypeDescription
api.clearSSO() ;
Supprime les fichiers cookies de l’authentification unique de l’appareil de l’utilisateur courant. Le code 204 est renvoyé dans la réponse si l’appel est réussi.
Exemple :
Copy
Full screen
Small screen
1// Request
2api
3  .clearSSO()
4  .then(() => {
5    // Success
6  });
Cet article vous a été utile ?
Merci !
Que pouvons-nous améliorer ? Message
Nous sommes désolés de l'apprendre
Dites-nous pourquoi vous n'avez pas trouvé cet article utile. Message
Merci pour votre commentaire !
Nous examinerons votre message et l'utiliserons pour améliorer votre expérience.
Dernière mise à jour: 19 Septembre 2025

Faute de frappe ou autre erreur dans le texte ? Sélectionnez le texte concerné et appuyez sur Ctrl+Entrée.

Signaler un problème
Nous améliorons continuellement notre contenu grâce à vos commentaires.
Indiquez votre adresse e-mail pour un suivi
Merci pour votre commentaire !
Impossible d'envoyer votre commentaire
Réessayez plus tard ou contactez-nous à doc_feedback@xsolla.com.