Sie können das Login-Widget oder Ihre Anwendung, die die Login API-Aufrufe nutzt, als Client einsetzen. Die Interaktion zwischen dem Client und dem Xsolla-Login-Server läuft wie folgt ab:

1. Der Client sendet Anfragen an den Xsolla-Login-Server. Das Anfrageformat ist unter Authentifizierungsmethoden erläutert.
2. Der Xsolla-Login-Server sendet Webhooks an Ihren Server. Der Header enthält einen Server-JWT mit dem Parameter “request_type”: “gateway_token”. Befolgen Sie die Anleitung, um die Tokenvalidierung einzurichten. Ein Teil der Benutzeridentifikationsdaten wird im Rumpf des Webhooks übermittelt.
3. Um den Empfang der Benutzeridentifikationsdaten des Webhook, muss Ihr Server folgendes zurückgeben: bei erfolgreicher Antwort den HTTP-Code
   • 200, 201, oder 204.
   • Den HTTP-Code 400 mit der Beschreibung des Problems, wenn der angegebene Benutzer nicht gefunden oder eine ungültige Signatur übermittelt wurde. Ihr Webhook-Handler könnte auch den HTTP-Code 5xx zurücksenden, falls vorübergehende Probleme auf Ihrem Server auftreten.
4. Der Xsolla-Login-Server verarbeitet eine Antwort von Ihrem Server und sendet den Autorisierungstoken an den Client zurück.
5. Der Client verarbeitet die Antwort.

Wenn Sie nach der Benutzeridentifikation Benutzerinformationen zum JWT hinzufügen möchten, senden Sie ein JSON-Objekt mit einem beliebigen Satz von Parametern im Body der Antwort. Dieses Objekt wird im Feld partner_data auf dem JWT gespeichert.

Sie können das Login-Widget oder Ihre Anwendung, die die Login API-Aufrufe nutzt, als Client einsetzen. Die Interaktion zwischen dem Client und dem Xsolla-Login-Server läuft wie folgt ab:

1. Der Client sendet Anfragen an den Xsolla-Login-Server. Das Anfrageformat ist unter Authentifizierungsmethoden erläutert.
2. Der Xsolla-Login-Server sendet Webhooks an Ihren Server. Der Header enthält einen Server-JWT mit dem Parameter “request_type”: “gateway_token”. Befolgen Sie die Anleitung, um die Tokenvalidierung einzurichten. Ein Teil der Benutzeridentifikationsdaten wird im Rumpf des Webhooks übermittelt.
3. Um den Empfang der Benutzeridentifikationsdaten des Webhook, muss Ihr Server folgendes zurückgeben: bei erfolgreicher Antwort den HTTP-Code
   • 200, 201, oder 204.
   • Den HTTP-Code 400 mit der Beschreibung des Problems, wenn der angegebene Benutzer nicht gefunden oder eine ungültige Signatur übermittelt wurde. Ihr Webhook-Handler könnte auch den HTTP-Code 5xx zurücksenden, falls vorübergehende Probleme auf Ihrem Server auftreten.

5. Der Xsolla-Login-Server verarbeitet eine Antwort von Ihrem Server und sendet den Autorisierungstoken an den Client zurück.
6. Der Client sendet die POST-Anfrage JWT generieren an den Xsolla-Login-Server. Im Anfragerumpf müssen zwingend die folgenden Parameter enthalten sein:
   • grant_type – wie der JWT gewährt wird; übermitteln Sie den Wert authorization_code.
   • client_id – OAuth-2.0-Client-ID.
   • client_secret – geheime OAuth-2.0-Client-ID. Erforderlich für den vertraulichen Authentifizierungstyp.
   • code – Autorisierungscode.
7. Der Xsolla-Login-Server sendet ein JWT-Paar (bestehend aus Zugriffstoken und Aktualisierungstoken) an den Client zurück.
8. Der Client verarbeitet die Antwort.
9. Wenn der Zugriffstoken abläuft, sendet der Client die POST-Anfrage JWT generieren an den Xsolla-Login-Server. Im Anfragerumpf müssen zwingend die folgenden Parameter enthalten sein:
   • grant_type – wie der JWT gewährt wird; übermitteln Sie den Wert refresh_token.
   • client_id – OAuth-2.0-Client-ID.
   • refresh_token – der Aktualisierungstoken, der in der Antwort auf die Benutzerautorisierungsanfrage empfangen wurde.

Sie können Benutzerinformationen dem JWT hinzufügen, wenn Sie einen Nutzer identifizieren und/oder ein Token aktualisieren. Geben Sie dazu ein JSON-Objekt mit Parametern im Antwortrumpf zurück. Dieses Objekt wird im Feld partner_data im JWT gespeichert.

1. Der Client sendet die POST-Anfrage Register new user an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • der Abfrageparameter projectId – ID des Login-Projekts im Kundenportal.
   • Rumpfparameter:
     • username – Benutzername. Zulässige Länge: 3-255 Zeichen.
     • password – Benutzerpasswort. Zulässige Länge: 6-100 Zeichen.
     • email – die E-Mail-Adresse des Nutzers. Zulässige Länge: 1-255 Zeichen.
2. Der Xsolla-Login-Server sendet einen Webhook an die URL für neue Nutzer. Die Antwort muss dem im Interaktionsablauf angegebenen Format entsprechen. In der Antwort können Sie eine Liste von Benutzerattributen und/oder ein erforderliches JSON-Objekt angeben. Das von Ihnen in der Antwort angegebene JSON-Objekt wird im Feld partner_data des Benutzer-JWT gespeichert.

Beispiel eines 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"}'

Beispiel einer Antwort auf einen Webhook mit Benutzerattributen:

 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}

Beispiel einer Antwort auf ein Webhook mit einem JSON-Objekt:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

3. Nutzerdaten werden in die Xsolla-Datenbank geschrieben, während der Parameter email als "unbestätigt" gekennzeichnet wird. Der Benutzer erhält eine E-Mail zur Kontobestätigung.
4. Wenn Sie das Login-Widget integriert haben, wird der Benutzer zur Seite weitergeleitet. Dabei wird ihm folgende Meldung angezeigt: Bitte bestätigen Sie Ihr Konto gemäß den Anweisungen, die wir Ihnen per E-Mail an {email} gesendet haben.
5. Auch bei einer fehlgeschlagenen Benutzerregistrierung können Sie eine Fehlermeldung im Authentifizierungs-Widget anzeigen. Übermitteln Sie dazu in der Antwort auf die Anfrage zur Benutzererstellung das Objekt error mit den folgenden Details:
   • Legen Sie im Parameter code einen Fehlercode fest, zum Beispiel den Wert 011-002.
   • Geben Sie im Parameter description den Fehlermeldungstext an.

Objekt mit einer Fehlermeldung (Beispiel):

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

1. Der Client sendet die POST-Anfrage Register new user an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • Abfrageparameter:
     • response_type – wie der JWT gewährt wird; übermitteln Sie den Wert code.
     • client_id – OAuth-2.0-Client-ID.
     • state – Wert für die zusätzliche Benutzerauthentifizierung. Erforderlich, um CSRF-Angriffe zu verhindern. Wird in der Antwort zurückgegeben. Zulässige Länge: 1 bis 8 Zeichen.
   • Rumpfparameter:
     • username – Benutzername. Zulässige Länge: 3 bis 255 Zeichen.
     • password – Benutzerpasswort. Zulässige Länge: 6-100 Zeichen.
     • email – E-Mail-Adresse des Nutzers. Zulässige Länge: 1 bis 255 Zeichen.
2. Der Xsolla-Login-Server sendet einen Webhook an die URL für neue Nutzer. Die Antwort muss dem in diesem Interaktionsablauf beschriebenen Format entsprechen. In der Antwort können Sie eine Liste von Benutzerattributen und/oder ein erforderliches JSON-Objekt angeben. Das von Ihnen in der Antwort angegebene JSON-Objekt wird im Feld partner_data des Benutzer-JWT gespeichert.

Beispiel eines 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"}'

Beispiel einer Antwort auf einen Webhook mit Benutzerattributen:

 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}

Beispiel einer Antwort auf ein Webhook mit einem JSON-Objekt:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

3. Nutzerdaten werden in die Xsolla-Datenbank geschrieben, während der Parameter email als "unbestätigt" gekennzeichnet wird. Der Benutzer erhält eine E-Mail zur Kontobestätigung.
4. Wenn Sie das Login-Widget integriert haben, wird der Benutzer zur Seite weitergeleitet. Dabei wird ihm folgende Meldung angezeigt: Bitte bestätigen Sie Ihr Konto gemäß den Anweisungen, die wir Ihnen per E-Mail an {email} gesendet haben.
5. Auch bei einer fehlgeschlagenen Benutzerregistrierung können Sie eine Fehlermeldung im Authentifizierungs-Widget anzeigen. Übermitteln Sie dazu in der Antwort auf die Anfrage zur Benutzererstellung das Objekt error mit den folgenden Details:
   • Legen Sie im Parameter code einen Fehlercode fest, zum Beispiel den Wert 011-002.
   • Geben Sie im Parameter description den Fehlermeldungstext an.

Objekt mit einer Fehlermeldung (Beispiel):

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

1. Der Client sendet die POST-Anfrage Auth by username and password an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • Der Abfrageparameter projectId – ID des Login-Projekts im Kundenportal.
   • Body-Parameter.
     • username – Benutzername. Zulässige Länge: 3-255 Zeichen.
     • password – Benutzerpasswort. Zulässige Länge: 6-100 Zeichen.
2. Der Xsolla-Login-Server sendet einen Webhook an die URL für die Benutzerverifizierung. Die Antwort muss dem in diesem Interaktionsablauf angegebenen Format entsprechen. In der Antwort können Sie eine Liste von Benutzerattributen und/oder ein erforderliches JSON-Objekt angeben. Das von Ihnen in der Antwort angegebene JSON-Objekt wird im Feld partner_data des Benutzer-JWT gespeichert.

Beispiel eines Webhooks für die URL zur Benutzerverifizierung:

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"}'

Beispiel einer Antwort auf einen Webhook mit Benutzerattributen:

 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}

Beispiel einer Antwort auf ein Webhook mit einem JSON-Objekt:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

3. Sollte die Benutzerauthentifizierung fehlschlagen, können Sie eine Fehlermeldung angeben, die im Authentifizierungs-Widget angezeigt wird. Dazu übermitteln Sie in der Antwort auf die Anfrage zur Benutzererstellung das Objekt error mit folgenden Angaben:
   • Im Parameter code legen Sie einen Fehlercode fest, zum Beispiel den Wert 011-002.
   • Im Parameter description geben Sie den Text der Fehlermeldung ein.
4. Der Xsolla-Login-Server generiert einen Benutzer-JWT.
5. Der Benutzer wird mit dem Abfrageparameter tokenzur login_urlweitergeleitet. Der Parameter token enthält den Benutzer-JWT.

1. Der Client sendet die POST-Anfrage Auth by username and password an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • Abfrageparameter:
     • response_type – wie der JWT gewährt wird; übermitteln Sie den Wert code.
     • client_id – OAuth-2.0-Client-ID.
     • state – Wert für die zusätzliche Benutzerauthentifizierung. Erforderlich, um CSRF-Angriffe zu verhindern. Wird in der Antwort zurückgegeben. Zulässige Länge: 1 bis 8 Zeichen.
   • Rumpfparameter:
     • username – Benutzername. Zulässige Länge: 3 bis 255 Zeichen.
     • password – Benutzerpasswort. Zulässige Länge: 6-100 Zeichen.
2. Der Xsolla-Login-Server sendet einen Webhook an die URL zur Benutzerverifizierung. Die Antwort muss dem in diesem Interaktionsablauf beschriebenen Format entsprechen. In der Antwort können Sie eine Liste von Benutzerattributen und/oder ein erforderliches JSON-Objekt angeben. Das von Ihnen in der Antwort angegebene JSON-Objekt wird im Feld partner_data des Benutzer-JWT gespeichert.

Beispiel eines Webhooks für die URL zur Benutzerverifizierung:

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"}'

Beispiel einer Antwort auf einen Webhook mit Benutzerattributen:

 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}

Beispiel einer Antwort auf ein Webhook mit einem JSON-Objekt:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

3. Sollte die Benutzerauthentifizierung fehlschlagen, können Sie eine Fehlermeldung angeben, die im Authentifizierungs-Widget angezeigt wird. Dazu übermitteln Sie in der Antwort auf die Anfrage zur Benutzererstellung das Objekt error mit folgenden Angaben:
   • Im Parameter code legen Sie einen Fehlercode fest, zum Beispiel den Wert 011-002.
   • Im Parameter description geben Sie den Text der Fehlermeldung ein.
4. Der Xsolla-Login-Server generiert einen Benutzer-JWT.
5. Der Benutzer wird mit dem Abfrageparameter tokenzur login_urlweitergeleitet. Der Parameter token enthält den Benutzer-JWT.

1. Der Client öffnet eine Authentifizierungsmaske, in die der Nutzer seine Telefonnummer eingeben kann.
2. Der Nutzer gibt seine Telefonnummer ein.
3. Der Client sendet die POST-Anfrage Start auth by phone number an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • der Abfrageparameter projectId – ID des Login-Projekts im Kundenportal.
   • der Rumpfparameter phone_number – Die Telefonnummer des Nutzers.
4. Der Client zeigt ein Feld an, in das der Nutzer den Verifizierungscode eingeben kann.
5. Der Nutzer gibt den erhaltenen Verifizierungscode ein.

6. Der Client sendet die POST-Anfrage Complete auth by phone number an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • der Abfrageparameter projectId – ID des Login-Projekts im Kundenportal.
   • die Rumpfparameter:
     • code – Bestätigungscode.
     • phone_number – die Telefonnummer des Nutzers.
     • operation_id – ID des Bestätigungscodes.
7. Wenn sich der Nutzer erstmalig autorisiert, sendet der Xsolla-Login-Server ein Webhook an die URL für passwortlose Anmeldung. Die Antwort muss dem in diesem Integrationsablauf beschriebenen Format entsprechen. In der Antwort können Sie eine Liste von Benutzerattributen oder ein erforderliches JSON-Objekt angeben. Das von Ihnen in der Antwort angegebene JSON-Objekt wird im Feld partner_data des Benutzer-JWT gespeichert.
8. Sie können eine Fehlermeldung angeben, die im Authentifizierungs-Widget angezeigt wird, falls die Benutzerauthentifizierung fehlschlägt. Übermitteln Sie dazu in der Antwort auf die Anfrage zum Anlegen eines neuen Nutzers das error-Objekt mit folgenden Angaben:
   • Im Parameter code legen Sie einen Fehlercode fest, zum Beispiel den Wert 011-002.
   • Im Parameter description geben Sie den Text der Fehlermeldung ein.

Beispiel eines Webhook:

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"}'

Beispiel einer Antwort auf einen Webhook mit Benutzerattributen:

 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}

Beispiel einer Antwort auf ein Webhook mit einem JSON-Objekt:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

1. Der Client öffnet eine Authentifizierungsmaske, in die der Nutzer seine Telefonnummer eingeben kann.
2. Der Nutzer gibt seine Telefonnummer ein.
3. Der Client sendet die POST-Anfrage Start auth by phone number an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • Abfrageparameter:
     • response_type – wie der JWT gewährt wird; übermitteln Sie den Wert code.
     • client_id – OAuth-2.0-Client-ID.
     • state – ein Wert für die zusätzliche Benutzerauthentifizierung. Erforderlich, um CSRF-Angriffe zu verhindern. Wird in der Antwort zurückgegeben. Zulässige Länge: 1 bis 8 Zeichen.
   • der Rumpfparameter phone_number – Telefonnummer des Nutzers.
4. Der Client zeigt ein Feld an, in das der Nutzer den Bestätigungscode eingeben kann.
5. Der Nutzer gibt den erhaltenen Bestätigungscode ein.

6. Der Client sendet die POST-Anfrage Complete auth by phone number an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • der Abfrageparameter client_id – OAuth-2.0-Client-ID.
   • Rumpfparameter:
     • code – Bestätigungscode.
     • phone_number – die Telefonnummer des Nutzers.
     • operation_id – ID des Bestätigungscodes.
7. Wenn sich der Nutzer erstmalig autorisiert, sendet der Xsolla-Login-Server ein Webhook an die URL für passwortlose Anmeldung. Die Antwort muss dem in diesem Integrationsablauf beschriebenen Format entsprechen. In der Antwort können Sie eine Liste von Benutzerattributen oder ein erforderliches JSON-Objekt angeben. Das von Ihnen in der Antwort angegebene JSON-Objekt wird im Feld partner_data des Benutzer-JWT gespeichert.
8. Sie können eine Fehlermeldung angeben, die im Authentifizierungs-Widget angezeigt wird, falls die Benutzerauthentifizierung fehlschlägt. Übermitteln Sie dazu in der Antwort auf die Anfrage zum Anlegen eines neuen Nutzers das error-Objekt mit folgenden Angaben:
   • Im Parameter code legen Sie einen Fehlercode fest, zum Beispiel den Wert 011-002.
   • Im Parameter description geben Sie den Text der Fehlermeldung ein.

Beispiel eines Webhook:

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"}'

Beispiel einer Antwort auf einen Webhook mit Benutzerattributen:

 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}

Beispiel einer Antwort auf ein Webhook mit einem JSON-Objekt:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

1. Der Client öffnet eine Authentifizierungsmaske, in die der Nutzer seine E-Mail-Adresse eingeben kann.
2. Der Nutzer gibt seine E-Mail-Adresse ein.
3. Der Client sendet die POST-Anfrage Start auth by email an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • der Abfrageparameter projectId – ID des Login-Projekts im Kundenportal.
   • der Rumpfparameter email – die E-Mail-Adresse des Nutzers.
4. Der Client zeigt ein Feld an, in das der Nutzer den Verifizierungscode eingeben kann.
5. Der Nutzer gibt den erhaltenen Verifizierungscode ein.

6. Der Client sendet die POST-Anfrage Complete auth by email an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • der Abfrageparameter projectId – ID des Login-Projekts im Kundenportal.
   • Rumpfparameter:
     • code – Bestätigungscode.
     • email – die E-Mail-Adresse des Nutzers.
     • operation_id – ID des Bestätigungscodes.
7. Wenn sich der Nutzer erstmalig autorisiert, sendet der Xsolla-Login-Server ein Webhook an die URL für passwortlose Anmeldung. Die Antwort muss dem in diesem Integrationsablauf beschriebenen Format entsprechen. In der Antwort können Sie eine Liste von Benutzerattributen oder ein erforderliches JSON-Objekt angeben. Das von Ihnen in der Antwort angegebene JSON-Objekt wird im Feld partner_data des Benutzer-JWT gespeichert.
8. Sie können eine Fehlermeldung angeben, die im Authentifizierungs-Widget angezeigt wird, falls die Benutzerauthentifizierung fehlschlägt. Übermitteln Sie dazu in der Antwort auf die Anfrage zum Anlegen eines neuen Nutzers das error-Objekt mit folgenden Angaben:
   • Im Parameter code legen Sie einen Fehlercode fest, zum Beispiel den Wert 011-002.
   • Im Parameter description geben Sie den Text der Fehlermeldung ein.

Beispiel eines 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"}'

Beispiel einer Antwort auf einen Webhook mit Benutzerattributen:

 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}

Beispiel einer Antwort auf ein Webhook mit einem JSON-Objekt:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

1. Der Client öffnet eine Authentifizierungsmaske, in die der Nutzer seine E-Mail-Adresse eingeben kann.
2. Der Nutzer gibt seine E-Mail-Adresse ein.
3. Der Client sendet die POST-Anfrage Start auth by email an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • Abfrageparameter:
     • response_type – wie der JWT gewährt wird; übermitteln Sie den Wert code.
     • client_id – OAuth-2.0-Client-ID.
     • state – ein Wert für die zusätzliche Benutzerauthentifizierung. Erforderlich, um CSRF-Angriffe zu verhindern. Wird in der Antwort zurückgegeben. Zulässige Länge: 1 bis 8 Zeichen.
   • der Rumpfparameter email – E-Mail-Adresse des Nutzers.
4. Der Client zeigt ein Feld an, in das der Nutzer den Bestätigungscode eingeben kann.
5. Der Nutzer gibt den erhaltenen Bestätigungscode ein.

6. Der Client sendet die POST-Anfrage Complete auth by email an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • der Abfrageparameter client_id – OAuth-2.0-Client-ID.
   • Rumpfparameter:
     • code – Bestätigungscode.
     • email – die E-Mail-Adresse des Nutzers.
     • operation_id – ID des Bestätigungscodes.
7. Wenn sich der Nutzer erstmalig autorisiert, sendet der Xsolla-Login-Server ein Webhook an die URL für passwortlose Anmeldung. Die Antwort muss dem in diesem Integrationsablauf beschriebenen Format entsprechen. In der Antwort können Sie eine Liste von Benutzerattributen oder ein erforderliches JSON-Objekt angeben. Das von Ihnen in der Antwort angegebene JSON-Objekt wird im Feld partner_data des Benutzer-JWT gespeichert.
8. Sie können eine Fehlermeldung angeben, die im Authentifizierungs-Widget angezeigt wird, falls die Benutzerauthentifizierung fehlschlägt. Übermitteln Sie dazu in der Antwort auf die Anfrage zum Anlegen eines neuen Nutzers das error-Objekt mit folgenden Angaben:
   • Im Parameter code legen Sie einen Fehlercode fest, zum Beispiel den Wert 011-002.
   • Im Parameter description geben Sie den Text der Fehlermeldung ein.

Beispiel eines 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"}'

Beispiel einer Antwort auf einen Webhook mit Benutzerattributen:

 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}

Beispiel einer Antwort auf ein Webhook mit einem JSON-Objekt:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

Geben Sie die URL für die Anmeldung über soziale Netzwerke in den Einstellungen Ihres Login-Projekts im Kundenportal (unter Nutzerdatenbank > Speicher > Eigener Speicher) an, um Nutzerdaten bei der Authentifizierung über soziale Netzwerke abzurufen. An diese URL wird eine Anfrage mit den vom sozialen Netzwerk empfangenen Daten gesendet.

Authentifizierungsablauf:

1. Der Client sendet die POST-Anfrage Auth via social network an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • der Abfrageparameter projectId – ID des Login-Projekts im Kundenportal.
   • der Pfadparameter provider_name – Name des sozialen Netzwerks, das im Kundenportal mit Login verknüpft ist. Mögliche Werte sind: amazon, apple, xsolla, 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. Der Benutzer meldet sich bei einem sozialen Netzwerk an.
3. Der Xsolla Login-Server verarbeitet die vom sozialen Netzwerk empfangenen Nutzerdaten und sendet einen Webhook an die URL für die Anmeldung über soziale Netzwerke. Die Antwort muss dem in diesem Interaktionsablauf beschriebenen Format entsprechen. In der Antwort können Sie eine Liste von Benutzerattributen und/oder ein beliebiges erforderliches JSON-Objekt angeben. Das JSON-Objekt, dass Sie in der Antwort angeben, wird im Feld partner_data des Benutzer-JWT gespeichert.

Nutzerdaten werden im Authorization-Header als temporärer Gateway-Token (Servertoken mit “request_type”: “gateway_token”) übermittelt.

Hauptfelder des Gateway Token:

Beispiel einer Token-Payload:

 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}

Beispiel eines Webhooks für die URL für die Anmeldung über soziale Netzwerke:

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'

Beispiel einer Antwort auf einen Webhook mit Benutzerattributen:

 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}

Beispiel einer Antwort auf ein Webhook mit einem JSON-Objekt:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

4. Bei einer fehlgeschlagenen Benutzerregistrierung können Sie eine Fehlermeldung im Authentifizierungs-Widget anzeigen. Übermitteln Sie dazu in der Antwort auf die Anfrage zur Benutzererstellung das Objekt error mit den folgenden Angaben:
   • Geben Sie im Parameter code den Wert 011-002 an.
   • Geben Sie im Parameter description den Fehlermeldungstext an.

Geben Sie die URL für die Anmeldung über soziale Netzwerke in den Einstellungen Ihres Login-Projekts im Kundenportal (unter Nutzerdatenbank > Speicher > Eigener Speicher) an, um Nutzerdaten bei der Authentifizierung über soziale Netzwerke abzurufen. An diese URL wird eine Anfrage mit den vom sozialen Netzwerk empfangenen Daten gesendet.

Authentifizierungsablauf:

1. Der Client sendet die POST-Anfrage Auth via social network an den Xsolla-Login-Server. In der Anfrage müssen zwingend die folgenden Parameter enthalten sein:
   • Abfrageparameter:
     • response_type – wie der JWT gewährt wird; übermitteln Sie den Wert code.
     • client_id – OAuth-2.0-Client-ID.
     • state – Wert für die zusätzliche Benutzerauthentifizierung. Erforderlich, um CSRF-Angriffe zu verhindern. Wird in der Antwort zurückgegeben. Zulässige Länge: 1 bis 8 Zeichen.
   • der Pfadparameter provider_name – Name des sozialen Netzwerks, das im Kundenportal mit Login verknüpft ist. Mögliche Werte sind: amazon, apple, xsolla, 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. Der Benutzer meldet sich bei einem sozialen Netzwerk an.
3. Der Xsolla Login-Server verarbeitet die vom sozialen Netzwerk empfangenen Nutzerdaten und sendet einen Webhook an die URL für die Anmeldung über soziale Netzwerke. Die Antwort muss dem in diesem Interaktionsablauf beschriebenen Format entsprechen. In der Antwort können Sie eine Liste von Benutzerattributen und/oder ein beliebiges erforderliches JSON-Objekt angeben. Das JSON-Objekt, dass Sie in der Antwort angeben, wird im Feld partner_data des Benutzer-JWT gespeichert.

Nutzerdaten werden im Authorization-Header als temporärer Gateway-Token (Servertoken mit “request_type”: “gateway_token”) übermittelt.

Hauptfelder des Gateway Token:

Beispiel einer Token-Payload:

 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}

Beispiel eines Webhooks für die URL für die Anmeldung über soziale Netzwerke:

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'

Beispiel einer Antwort auf einen Webhook mit Benutzerattributen:

 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}

Beispiel einer Antwort auf ein Webhook mit einem JSON-Objekt:

 1{
 2  "user": {
 3    "player_id": "12345678",
 4    "email": "user@example.com"
 5  },
 6  "user_info": {
 7    "username": "gamer123",
 8    "user_first_name": "John",
 9    "user_last_name": "Doe",
10    "gender": "male",
11    "birthday": "1990-05-15",
12    "country": "US",
13    "language": "en"
14  },
15  "subscription_status": "active",
16  "loyalty_level": "gold"
17
18}

4. Bei einer fehlgeschlagenen Benutzerregistrierung können Sie eine Fehlermeldung im Authentifizierungs-Widget anzeigen. Übermitteln Sie dazu in der Antwort auf die Anfrage zur Benutzererstellung das Objekt error mit den folgenden Angaben:
   • Geben Sie im Parameter code den Wert 011-002 an.
   • Geben Sie im Parameter description den Fehlermeldungstext an.