Benutzerdefinierter Nutzerdatenspeicher

Falls Sie den benutzerdefinierten Nutzerdatenspeicher verwenden, fungiert Xsolla Login als Vermittler, und alle Benutzeridentifikationsdaten werden auf Ihrer Seite gespeichert. Xsolla Login übergibt die Authentifizierungsdaten in einem Token, das in der Kopfzeile von Webhooks und in deren Bodys enthalten ist.

• Benutzerregistrierung
• Authentifizierung über Benutzername und Passwort
• passwortlose Authentifizierung über eine E-Mail-Adresse
• Authentifizierung über soziale Netzwerke
• Zurücksetzen von Benutzerpasswörtern

Interaktionsablauf

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 in den Endpunkten JWT und Password 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 Anleitun, um die Tokenvalidierung einzurichten. Ein Teil der Benutzeridentifikationsdaten wird im Body 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, sollten vorübergehende Probleme auf Ihrem Server vorkommen.
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.

• E-Mail-Adresse
• Geburtsdatum
• Vorname
• NAchname
• Benutzer-ID auf Ihrem Server

Benutzerregistrierung

1. Der Client sendet die Anfrage Register new userPOST an den Xsolla-Login-Server. Die Anfrage muss den Header Authorization: Bearer {JWT} und die folgenden erforderlichen Parameter enthalten:
   • Der Abfrageparameter projectId- ID des Login-Projekts im Kundenportal.
   • Body-Parameter.
     • username - Benutzername. Erlaubte Länge: 3-255 Zeichen.
     • password - Benutzerpasswort. Erlaubte Länge: 6-100 Zeichen.
     • email - Die E-Mail-Adresse des Benutzers. Erlaubte Länge: 1-255 Zeichen.
2. Der Xsolla-Login-Server sendet einen Webhook an die URL des neuen Benutzers. 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 aufgezeichnet.

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    "id": 123456,
3    "role": "scout"
4}

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 Fehlercodefest, zum Beispiel den Wert 011-002.
   • Geben Sie im Parameter description den Fehlermeldungstext an.

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

Authentifizierung über Benutzername und Passwort

1. Der Client sendet die Anfrage Auth by username and passwordPOST an den Xsolla-Login-Server. Die Anfrage muss den Header Authorization: Bearer {JWT} und die folgenden erforderlichen Parameter enthalten:
   • Der Abfrageparameter projectId- ID des Login-Projekts im Kundenportal.
   • Body-Parameter.
     • username - Benutzername. Erlaubte Länge: 3-255 Zeichen.
     • password - Benutzerpasswort. Erlaubte 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 aufgezeichnet.

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    "id": 123456,
3    "role": "scout"
4}

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 Wert011-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.

Passwortlose Authentifizierung über eine Telefonnummer

1. Der Client öffnet ein Authentifizierungsformular, damit der Benutzer seine Telefonnummer eingeben kann.
2. Der Benutzer gibt seine Telefonnummer ein.
3. Der Client sendet die Anfrage Start auth by phone numberPOST an den Xsolla-Login-Server. Die Anfrage muss den Header Authorization: Bearer {JWT} und die folgenden erforderlichen Parameter enthalten:
   • Den Anfrageparameter projectId - ID des Login-Projekts im Kundenportal.
   • Den Body-Parameter phone_number - Die Telefonnummer des Benuters.
4. Der Client zeigt ein Feld, damit der Benutzer den Verifizierungscode eingeben kann.
5. Der Benutzer gibt den erhaltenen Verifizierungscode ein.

6. Der Client sendet die Anfrage Complete auth by phone numberPOST an den Xsolla-Login-Server. Die Anfrage muss den Header Authorization: Bearer {JWT} und die folgenden erforderlichen Parameter enthalten:
   • Der Anfrageparameter projectId - ID des Login-Projekts im Kundenportal.
   • Die Body-Parameter:
     • code - Bestätigungscode.
     • phone_number - die Telefonnummer des Benutzers.
     • operation_id - ID des Bestätigungscodes.
7. Wenn sich der Benutzer erstmalig autorisiert, sendet der Xsolla-Login-Server ein Webhook an die URL für eine 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 aufgezeichnet.
8. 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 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.

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    "id": 123456,
3    "role": "scout"
4}

Passwortlose Authentifizierung über E-Mail

1. Der Client öffnet ein Authentifizierungsformular, damit der Benutzer seine E-Mail-Adresse eingeben kann.
2. Der Benutzer gibt seine E-Mail-Adresse ein.
3. Der Client sendet die Anfrage Start auth by emailPOST an den Xsolla-Login-Server. Die Anfrage muss den Header Authorization: Bearer {JWT} und die folgenden erforderlichen Parameter enthalten:
   • Den Anfrageparameter projectId - ID des Login-Projekts im Kundenportal.
   • Den Body-Parameter email - Die E-Mail-Adresse des Benutzers.
4. Der Client zeigt ein Feld, damit der Benutzer den Verifizierungscode eingeben kann.
5. Der Benutzer gibt den erhaltenen Verifizierungscode ein.

6. Der Client sendet die Anfrage Complete auth by emailPOST an den Xsolla-Login-Server. Die Anfrage muss den Header Authorization: Bearer {JWT} und die folgenden erforderlichen Parameter enthalten:
   • Der Anfrageparameter projectId - ID des Login-Projekts im Kundenportal.
   • Die Body-Parameter:
     • username - Benutzername. Erlaubte Länge: 3 bis 255 Zeichen.
     • code - Bestätigungscode
     • email - E-Mail-Adresse des Benutzers
     • operation_id - ID des Bestätigungscodes
7. Wenn sich der Benutzer erstmalig autorisiert, sendet der Xsolla-Login-Server ein Webhook an die URL für eine 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 aufgezeichnet..
8. 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.

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    "id": 123456,
3    "role": "scout"
4}

Authentifizierung über soziale Netzwerke

Geben Sie die URL für die Anmeldung über soziales Netzwerk 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 Anfrage Auth via social networkPOST an den Xsolla-Login-Server. Die Anfrage muss den Header Authorization: Bearer {JWT} und die folgenden erforderlichen Parameter enthalten:
   • Den Anfrageparameter projectId - ID des Login-Projekts im Kundenportal.
   • Den Pfadparameter provider_name - Name des sozialen Netzwerks, der mit dem Login im Kundenportal verknüpft ist. Das können Folgende sein: 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. 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 soziales Netzwerk. 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 aufgezeichnet.

Benutzerdaten werden im Authorization-Header als vorübergehender Gateway Token (ein Server Token mit “request_type”: “gateway_token”). Hauptfelder des Gateway Token:

 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    "id": 123456,
3    "role": "scout"
4}

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.

Benutzerpasswörter zurücksetzen

1. Der Client sendet die Anfrage Reset passwordPOST an den Xsolla-Login-Server. Die Anfrage muss den Header Authorization: Bearer {JWT} und die folgenden erforderlichen Parameter enthalten:
   • Der Anfrageparameter projectId - ID des Login-Projekts im Kundenportal.
   • Den Body-Parameter username - Benutzername. Erlaubte Länge: 3 bis 255 Zeichen.
2. Der Xsolla-Login-Server sendet dem Benutzer eine Bestätigung über die Zurücksetzung des Passworts per E-Mail.
3. Nachdem der Benutzer das Zurücksetzen des Passworts in der E-Mail bestätigt hat, wird er auf die entsprechende Seite weitergeleitet.
4. Der Benutzer gibt ein neues Passwort ein.
5. Der Xsolla-Login-Server sendet ein Webhook an die URL zum Zurücksetzen des Passworts.
6. Sollte das Zurücksetzen des Kennworts 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.

URL-Webhook-Beispiel für das Zurücksetzen des Passworts:

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

Weitere Informationen