Stockage de données utilisateur personnalisé

Si vous utilisez un stockage de données utilisateur personnalisé, Xsolla Login agit en tant qu’intermédiaire et toutes les données d’identification utilisateur sont stockées de votre côté. Xsolla Login passe les données d’authentification dans le jeton inclus dans l’en-tête des webhooks ainsi que dans leur corps.

• enregistrement utilisateur ;
• authentification par nom d’utilisateur et mot de passe ;
• authentification sans mot de passe par numéro de téléphone ;
• authentification sans mot de passe par e-mail ;
• authentification via les réseaux sociaux ;
• réinitialisation du mot de passe utilisateur.

Flux d'interaction

Vous pouvez utiliser le widget de connexion ou votre application, qui utilise les appels Login API, comme client. Le flux d’interaction entre le client et le serveur Xsolla Login est comme suit :

1. Le client envoie des requêtes au serveur Xsolla Login. Le format des requêtes est décrit dans les endpoints JWT et Password.
2. Le serveur Xsolla Login envoie des webhooks à votre serveur. L’en-tête comprend un JWT serveur avec le paramètre “request_type”: “gateway_token”. Pour configurer la validation du jeton, suivez ces instructions. Une partie des données d’identification utilisateur est passée dans le corps du webhook.
3. Pour confirmer la réception du webhook, votre serveur doit renvoyer :
   • un code HTTP 200, 201 ou 204 en cas de réponse positive ;
   • un code HTTP 400 avec une description du problème si l’utilisateur spécifié n’a pas été trouvé ou si une signature non valide a été passée. Votre gestionnaire de webhooks peut également renvoyer un code HTTP 5xx en cas de problèmes temporaires sur votre serveur.
4. Le serveur Xsolla Login traite la réponse de votre serveur et renvoie le jeton d’autorisation au client.
5. Le client traite la réponse.

Si vous souhaitez ajouter des informations sur l’utilisateur au JWT après son identification, renvoyez un objet JSON avec l’ensemble de paramètres souhaités dans le corps de la réponse. Cet objet sera enregistré dans le champ partner_data du JWT.

• adresse e-mail ;
• pseudo ;
• date de naissance ;
• prénom ;
• nom ;
• ID utilisateur sur votre serveur.

Enregistrement utilisateur

1. Le client envoie la requête POST Register new user au serveur Xsolla Login. La requête doit inclure l'en-tête Authorization: Bearer {JWT} et les paramètres obligatoires suivants :
   • Le paramètre de requête projectId — ID du projet de Login dans le Compte éditeur ;
   • Les paramètres de corps suivants :
     • username — nom d'utilisateur. Longueur autorisée : 3 à 255 caractères,
     • password — mot de passe d'utilisateur. Longueur autorisée : 6 à 100 caractères,
     • email — adresse e-mail de l'utilisateur. Longueur autorisée : 1 à 255 caractères.
2. Le serveur Xsolla Login envoie un webhook à l'URL de nouvel utilisateur. La réponse doit être dans le format décrit dans le flux d'interaction. Dans la réponse, vous pouvez spécifier une liste d'attributs utilisateur et/ou tout objet JSON nécessaire. L'objet JSON dans la réponse est enregistré dans le champ partner_data du JWT utilisateur.

Exemple de webhook :

1POST https://your.hostname/your_registration_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email":"j.smith@email.com",
7  "password":"123456",
8  "username":"j.smith@email.com"
9}

1curl --request POST \
2  --url 'https://your.hostname/your_registration_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email":"j.smith@email.com","password":"123456","username":"j.smith@email.com"}'

Exemple de réponse à un webhook avec des attributs utilisateur :

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemple de réponse à un webhook avec un objet JSON :

1{ 
2    "id": 123456,
3    "role": "scout"
4}

3. Les données utilisateur sont enregistrées dans la base de données Xsolla tant que l'email est marqué comme non confirmé. L'utilisateur recevra un e-mail de confirmation de compte.
4. Si vous avez intégré le widget Login, l'utilisateur sera redirigé vers une page affichant le message suivant : Please confirm your account following the instructions we sent to {email}.
5. Si l'inscription de l'utilisateur échoue, fournissez un message d'erreur qui s'affichera dans le widget d'authentification. Pour ce faire, dans la réponse à la requête de création d'utilisateur, passez l'objet error avec les informations suivantes :
   • Dans le paramètre code, spécifiez un code d'erreur, par exemple, 011-002 ;
   • Dans le paramètre description, fournissez le texte du message d'erreur.

1{
2  "error": {
3    "code": "011-002",
4    "description": "<string>"
5  }
6}

Authentification par nom d'utilisateur et mot de passe

1. Le client envoie la requête POST Auth by username and password au serveur Xsolla Login. La requête doit inclure l'en-tête Authorization: Bearer {JWT} et les paramètres obligatoires suivants :
   • Le paramètre de requête projectId — ID du projet de Login dans le Compte éditeur ;
   • Les paramètres de corps suivants :
     • username — nom d'utilisateur. Longueur autorisée : 3 à 255 caractères,
     • password — mot de passe d'utilisateur. Longueur autorisée : 6 à 100 caractères.
2. Le serveur Xsolla Login envoie un webhook à l'URL de vérification utilisateur. La réponse doit être dans le format décrit dans ce flux d'interaction. Dans la réponse, vous pouvez spécifier une liste d'attributs utilisateur et/ou tout objet JSON nécessaire. L'objet JSON dans la réponse est enregistré dans le champ partner_data du JWT utilisateur.

Exemple de webhook à l’URL de vérification utilisateur :

1POST https://your.hostname/your_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email":"j.smith@email.com",
7  "password":"123456",
8  "username":"j.smith@email.com"
9}

1curl --request POST \
2  --url 'https://your.hostname/your_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email":"j.smith@email.com","password":"123456","username":"j.smith@email.com"}'

Exemple de réponse à un webhook avec des attributs utilisateur :

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemple de réponse à un webhook avec un objet JSON :

1{ 
2    "id": 123456,
3    "role": "scout"
4}

3. Si l'authentification utilisateur échoue, fournissez un message d'erreur qui s'affichera dans le widget d'authentification. Pour ce faire, dans la réponse à la requête de création d'utilisateur, passez l'objet error avec les informations suivantes :
   • Dans le paramètre code, spécifiez un code d'erreur, par exemple 011-002 ;
   • Dans le paramètre description, fournissez le texte du message d'erreur.
4. Le serveur Xsolla Login génère un JWT utilisateur.
5. L'utilisateur est redirigé vers login_url avec un paramètre de requête token. Le paramètre token contient le JWT utilisateur.

Authentification sans mot de passe par numéro de téléphone

1. Le client ouvre un formulaire d'authentification pour que l'utilisateur puisse entrer son numéro de téléphone.
2. L'utilisateur entre son numéro de téléphone.
3. Le client envoie la requête POST Start auth by phone number au serveur Xsolla Login. La requête doit inclure l'en-tête Authorization: Bearer {JWT} et les paramètres obligatoires suivants :
   • Le paramètre de requête projectId — ID du projet de Login dans le Compte éditeur ;
   • Le paramètre de corps phone_number — numéro de téléphone de l'utilisateur.
4. Le client affiche un champ permettant à l'utilisateur de saisir le code de vérification.
5. L'utilisateur saisit le code de vérification reçu.

6. Le client envoie la requête POST Complete auth by phone number au serveur Xsolla Login. La requête doit inclure l'en-tête Authorization: Bearer {JWT} et les paramètres obligatoires suivants :
   • Le paramètre de requête projectId — ID du projet de Login dans le Compte éditeur ;
   • Les paramètres de corps suivants :
     • code — code de confirmation,
     • phone_number — numéro de téléphone de l'utilisateur,
     • operation_id — ID de code de confirmation.
7. S'il s'agit de la première autorisation de l'utilisateur, le serveur Xsolla Login envoie un webhook à l'URL de connexion sans mot de passe. La réponse doit être dans le format décrit dans le flux d'interaction. Dans la réponse, vous pouvez spécifier une liste d'attributs utilisateur et/ou tout objet JSON nécessaire. L'objet JSON que vous fournissez dans la réponse est enregistré dans le champ partner_data du JWT utilisateur.
8. Si l'authentification utilisateur échoue, fournissez un message d'erreur qui s'affichera dans le widget d'authentification. Pour ce faire, dans la réponse à la requête de création d'utilisateur, passez l'objet error avec les informations suivantes :
   • Dans le paramètre code, spécifiez un code d'erreur, par exemple 011-002 ;
   • Dans le paramètre description, fournissez le texte du message d'erreur.

1POST https://your.hostname/your_phone_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "login": "+12025550140",
7  "type": "phone"
8}

1curl --request POST \
2  --url 'https://your.hostname/your_phone_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"login":"+12025550140","type":"phone"}'

Exemple de réponse à un webhook avec des attributs utilisateur :

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemple de réponse à un webhook avec un objet JSON :

1{ 
2    "id": 123456,
3    "role": "scout"
4}

Authentification sans mot de passe par e-mail

1. Le client ouvre un formulaire d'authentification pour que l'utilisateur puisse entrer son adresse e-mail.
2. L'utilisateur entre son adresse e-mail.
3. Le client envoie la requête POST Start auth by email au serveur Xsolla Login. La requête doit inclure l'en-tête Authorization: Bearer {JWT} et les paramètres obligatoires suivants :
   • Le paramètre de requête projectId — ID du projet de Login dans le Compte éditeur ;
   • Le paramètre de corps email — adresse e-mail de l'utilisateur.
4. Le client affiche un champ permettant à l'utilisateur de saisir le code de vérification.
5. L'utilisateur saisit le code de vérification reçu.

6. Le client envoie la requête POST Complete auth by email au serveur Xsolla Login. La requête doit inclure l'en-tête Authorization: Bearer {JWT} et les paramètres obligatoires suivants :
   • Le paramètre de requête projectId — ID du projet de Login dans le Compte éditeur ;
   • Les paramètres de corps suivants :
     • username — nom d'utilisateur. Longueur autorisée : 3 à 255 caractères,
     • code — code de confirmation,
     • email — adresse e-mail de l'utilisateur,
     • operation_id — ID de code de confirmation.
7. S'il s'agit de la première autorisation de l'utilisateur, le serveur Xsolla Login envoie un webhook à l'URL de connexion sans mot de passe. La réponse doit être dans le format décrit dans le flux d'interaction. Dans la réponse, vous pouvez spécifier une liste d'attributs utilisateur et/ou tout objet JSON nécessaire. L'objet JSON que vous fournissez dans la réponse est enregistré dans le champ partner_data du JWT utilisateur.
8. Si l'authentification utilisateur échoue, fournissez un message d'erreur qui s'affichera dans le widget d'authentification. Pour ce faire, dans la réponse à la requête de création d'utilisateur, passez l'objet error avec les informations suivantes :
   • Dans le paramètre code, spécifiez un code d'erreur, par exemple 011-002 ;
   • Dans le paramètre description, fournissez le texte du message d'erreur.

Exemple de webhook :

1POST https://your.hostname/your_email_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{
6  "email": "user@mail.com",
7  "type": "email"
8}

1curl --request POST \
2  --url 'https://your.hostname/your_email_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email": "user@mail.com","type": "email"}'

Exemple de réponse à un webhook avec des attributs utilisateur :

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemple de réponse à un webhook avec un objet JSON :

1{ 
2    "id": 123456,
3    "role": "scout"
4}

Authentification via les réseaux sociaux

Pour obtenir les données utilisateur lors de l’authentification via les réseaux sociaux, spécifiez Social Login URL dans les paramètres de votre projet de connexion dans le Compte utilisateur (section User database > Storage > Custom storage). Une requête contenant les données reçues du réseau social est envoyée à cette URL.

Flux d’authentification :

1. Le client envoie la requête POST Auth via social network au serveur Xsolla Login. La requête doit inclure l’en-tête Authorization: Bearer {JWT} et les paramètres obligatoires suivants :
   • Le paramètre de requête projectId — ID du projet de Login dans le Compte éditeur ;
   • Le paramètre de chemin provider_name — nom du réseau social connecté à Login dans le Compte éditeur. Il peut s’agir de : amazon, apple, babka, baidu, battlenet, discord, epicgames, facebook, github, google, kakao, linkedin, mailru, microsoft, msn, naver, ok, paypal, qq, reddit, steam, twitch, twitter, vimeo, vk, wechat, weibo, xbox, yahoo, yandex, youtube.
2. L’utilisateur se connecte à un réseau social.
3. Le serveur Xsolla Login traite les données utilisateur reçues du réseau social et envoie un webhook à l’URL de connexion via les réseaux sociaux. La réponse doit être dans le format décrit dans le flux d’interaction. Dans la réponse, vous pouvez spécifier une liste d’attributs utilisateur et/ou tout objet JSON nécessaire. L’objet JSON que vous fournissez dans la réponse est enregistré dans le champ partner_data du JWT de l’utilisateur.

Les données utilisateur sont passées dans l’en-tête Authorization sous la forme d’un jeton de passerelle temporaire (un jeton serveur avec “request_type”: “gateway_token”). Principaux champs du jeton de passerelle :

 1{
 2  "exp": 1573635020,
 3  "iat": 1573634600,
 4  "iss": "https://login.xsolla.com",
 5  "request_type": "gateway_request",
 6  "xsolla_login_project_id": "00000000-0000-0000-0000-000000000000",
 7  "sub": "00000000-0000-0000-0000-000000000000",
 8  "email": "example@test.com",
 9  "username": "Smith707",
10  "provider": "google",
11  "id": "123",
12}

Exemple de webhook à l’URL de connexion via les réseaux sociaux :

1POST https://your.hostname/your_social_authentication_uri HTTP/1.1
2Authorization: Bearer {JWT}
3Content-Type: application/json
4
5{}

1curl --request POST \
2  --url 'https://your.hostname/your_social_authentication_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json'

Exemple de réponse à un webhook avec des attributs utilisateur :

 1{
 2    "attributes": [
 3      {
 4        "attr_type": "server",
 5        "key": "company",
 6        "permission": "private",
 7        "value": "facebook-promo"
 8      },
 9      {
10        "attr_type": "server",
11        "key": "custom-id",
12        "permission": "private",
13        "value": 48582
14      }
15    ]
16}

Exemple de réponse à un webhook avec un objet JSON :

1{ 
2    "id": 123456,
3    "role": "scout"
4}

4. Si l'authentification utilisateur échoue, fournissez un message d'erreur qui s'affichera dans le widget d'authentification. Pour ce faire, dans la réponse à la requête de création d'utilisateur, passez l'objet error avec les informations suivantes :
   • Dans le paramètre code, spécifiez un code d'erreur, par exemple 011-002 ;
   • Dans le paramètre description, fournissez le texte du message d'erreur.

Réinitialisation du mot de passe utilisateur

1. Le client envoie la requête POST Reset password au serveur Xsolla Login. La requête doit inclure l'en-tête Authorization: Bearer {JWT} et les paramètres obligatoires suivants :
   • Le paramètre de requête projectId — ID du projet de Login dans le Compte éditeur ;
   • Le paramètre de corps username — nom d'utilisateur. Longueur autorisée : 3 à 255 caractères.
2. Le serveur Xsolla Login envoie à l'utilisateur un e-mail de confirmation de réinitialisation du mot de passe.
3. Après avoir confirmé la réinitialisation du mot de passe via l'e-mail, l'utilisateur est redirigé vers la page de saisie du nouveau mot de passe.
4. L'utilisateur saisit un nouveau mot de passe.
5. Le serveur Xsolla Login envoie un webhook à l'URL de réinitialisation du mot de passe.
6. Si la réinitialisation du mot de passe échoue, fournissez un message d'erreur qui s'affichera dans le widget d'authentification. Pour ce faire, dans la réponse à la requête de création d'utilisateur, passez l'objet error avec les informations suivantes :
   • Dans le paramètre code, spécifiez un code d'erreur, par exemple 011-002 ;
   • Dans le paramètre description, fournissez le texte du message d'erreur.

Exemple de webhook à l’URL de réinitialisation du mot de passe :

 1POST https://your.hostname/your_reset_uri HTTP/1.1
 2Authorization: Bearer {JWT}
 3Content-Type: application/json
 4
 5{
 6  "username": "john@gmail.com",
 7  "fields": {
 8    "password": "NewPa$$word1"
 9  }
10}

1curl --request POST \
2  --url 'https://your.hostname/your_reset_uri' \
3  --header 'authorization: bearer_JWT' \
4  --header 'content-type: application/json' \
5  --data '{"email":"john@gmail.com","fields":{"password":"NewPa$$word1"}}'

Poursuivre la lecture