Xsolla-logo

Lancer l'authentification par adresse e-mailClient-side

post/login/email/request

Lance l'authentification par adresse e-mail utilisateur et envoie un code de confirmation par e-mail à l'utilisateur. La durée de vie du code est de 3 minutes.

Cet appel est utilisé uniquement avec l'appel Compléter l'authentification par adresse e-mail.

Flux d'utilisation de cet appel :

  1. L'application ouvre un formulaire d'authentification pour que l'utilisateur puisse saisir son adresse e-mail.
  2. L'utilisateur saisit son adresse e-mail.
  3. L'application envoie cette requête au serveur Xsolla Login : a. Si la valeur du paramètre send_link est true, après cette requête, vous devez envoyer la requête Lire un code de confirmation pour que l'e-mail contienne le code de confirmation et le lien ; b. Si la valeur du paramètre send_link est false ou n'est pas passée, l'e-mail contiendra uniquement le code de confirmation.
  4. Le serveur Xsolla Login envoie l'e-mail et renvoie l'ID du code de confirmation.
  5. L'application affiche un champ pour que l'utilisateur puisse saisir le code de confirmation.
  6. L'utilisateur saisit le code de confirmation reçu ou suit le lien.
  7. L'application envoie la requête Compléter l'authentification par adresse e-mail au serveur Xsolla Login avec l'ID reçu.
  8. L'utilisateur est considéré comme autorisé.
Request
query Parameters
projectId
required
string <uuid>

ID de projet de connexion issu du Compte éditeur.

login_url
string

URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. For the scenario of a login error, the value should be identical to the the Error callback URL specified in the URL block of Publisher Account. To find the settings, go to Login > your Login project and select the Callback URLs section in the upper block. Required if there are several Callback URLs.

payload
string

Vos données personnalisées. La valeur du paramètre sera renvoyée dans la revendication payload du JWT utilisateur. La longueur maximale recommandée est de moins de 500 caractères. Notez que ce paramètre n'est disponible qu'avec un stockage de données utilisateur personnalisé.

with_logout
string
Default: "0"

Indique s'il faut désactiver les valeurs existantes du JWT utilisateur et activer celles générées par cet appel. Valeurs possibles :

  • 1 : pour désactiver les valeurs existantes et en activer une nouvelle ;
  • 0 : pour garder les valeurs existantes activées.
Request Body schema: application/json
email
required
string [ 1 .. 255 ] characters

Adresse e-mail de l'utilisateur.

link_url
string <uri>

URL de redirection de l'utilisateur vers la page d'état de l'authentification. Requis si la valeur du paramètre send_link est true.

send_link
boolean

Indique si un lien est envoyé avec le code de confirmation dans l'e-mail ou non.

Le lien peut être utilisé à la place du code de confirmation pour se connecter.

Si la valeur du paramètre est true, le lien est envoyé dans l'e-mail.

Responses
200

OK

400

bad request

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

Request samples
application/json
{}
Response samples
application/json
{
  • "operation_id": "string"
}