So nutzen Sie Pay Station in Kombination mit der PlayFab-Authentifizierung

Wenn Sie in Ihrer Anwendung bereits eine auf PlayFab beruhende Benutzerauthentifizierung implementiert haben, können Sie bei PlayFab einen Zahlungstoken generieren und ihn dann an den Anwendungs-Client übermitteln, um das Zahlungsportal zu öffnen.

Bei dieser Integrationsoption müssen Sie die Logik, gemäß der das Land des Nutzers und die entsprechende Zahlungswährung ermittelt wird, selbst implementieren.

Integrationsablauf:

1. Projekt erstellen:

1. Registrieren Sie sich im Kundenportal, und erstellen Sie ein neues Projekt. Im weiteren Verlauf dieser Anleitung benötigen Sie die ID des erstellten Projekts.

2. Katalog einrichten:
   • Erstellen Sie einen Artikelkatalog bei Xsolla. Sie können Artikel manuell hinzufügen oder diese aus Google Play oder PlayFab importieren.
   • Implementieren Sie mithilfe des SDK, dass der Artikelkatalog aufseiten des Anwendungs-Clients abgerufen und angezeigt wird.

3. Artikelverkauf einrichten:
   • Legen Sie mithilfe eines PlayFab-Cloud-Skripts eine Bestellung mit Nutzer- und Artikeldaten aufseiten des Anwendung-Clients an.
   • Implementieren Sie mithilfe des SDK, dass das Zahlungsportal aufseiten des Anwendungs-Clients geöffnet wird.

4. Richten Sie das Bestellstatus-Tracking ein.

Projekt erstellen

Im Kundenportal registrieren

Das Kundenportal ist das wichtigste Tool für die Konfiguration der Xsolla-Funktionen und auch für die Arbeit mit Analytics und Transaktionen unerlässlich.

Die bei der Registrierung angegebenen Daten zu Ihrer Firma und zu Ihrer Anwendung dienen dazu, eine Entwurfsfassung der Xsolla-Lizenzvereinbarung zu erstellen und für Sie geeignete Lösungen vorzuschlagen. Sie können die Daten später ändern, allerdings verkürzt sich die Dauer bis zur Lizenzvereinbarungsunterzeichnung, wenn Sie bei der Registrierung korrekte Angaben machen.

Wechseln Sie zum Kundenportal, und erstellen Sie ein Konto, um sich zu registrieren.

Projekt im Kundenportal erstellen

Wenn Sie mehrere Anwendungen haben, empfehlen wir Ihnen, für jede Anwendung ein eigenes Projekt zu erstellen. Auf der Grundlage der bei der Projekterstellung angegebenen Daten generiert Xsolla Empfehlungen und schlägt für Sie geeignete Lösungen vor.

So erstellen Sie ein neues Projekt:

1. Öffnen Sie das Kundenportal.
2. Klicken Sie in der Seitenleiste auf Projekt erstellen.

3. Vergeben Sie einen englischen Namen für Ihr Projekt (erforderlich).

4. Wählen Sie eine oder mehrere Release-Plattformen für Ihr Spiel aus (erforderlich).
5. Geben Sie einen Link zu Ihrem Spiel ein. Wenn Ihr Spiel noch keine Website hat, geben Sie einen Link zu einer Quelle ein, die Informationen über das Spiel enthält (erforderlich).
6. Wählen Sie die Spiel-Engine aus.
7. Wählen Sie die Monetarisierungsoptionen, die Sie verwenden oder planen zu verwenden.
8. Geben Sie an, ob das Spiel bereits veröffentlicht wurde. Wenn das Spiel noch nicht veröffentlicht wurde, geben Sie den geplanten Release-Termin an.
9. Klicken Sie auf Projekt erstellen.

Während des Integrationsprozesses benötigen Sie die Projekt-ID. Diese wird im Kundenportal neben dem Projektnamen angezeigt.

Katalog einrichten

Artikel im Kundenportal erstellen

So erstellen Sie einen virtuellen Gegenstand im Katalog:

1. Öffnen Sie Ihr Projekt im Kundenportal.
2. Klicken Sie in der Seitenleiste auf Store.
3. Klicken Sie bei Virtuelle Gegenstände auf Verknüpfen.
4. Wählen Sie in der Drop-down-Liste den Menüpunkt Artikel anlegen.

5. Legen Sie die Grundeinstellungen des Artikels fest:
   • Bild (optional)
   • SKU (individuelle Artikel-ID)
   • Gegenstandsname 
   • Beschreibung (optional)

6. Legen Sie den Artikelpreis fest:
   1. Stellen Sie den Schalter Preise in echter Währung auf Ein.
   2. Im Feld Standard-Währung können Sie wahlweise die Währung ändern. Legen Sie den Artikelpreis fest.
   3. Sollten Sie die Währung im Feld Standard-Währung geändert haben, müssen Sie unter Preis in echter Währung dieselbe Währung auswählen.

7. Ändern Sie den Artikelstatus in Verfügbar.

8. Klicken Sie auf Artikel anlegen.

SDK installieren und einrichten

1. Laden Sie den Epic Games Launcher herunter.
2. Erstellen Sie ein neues Unreal Engine-Projekt.

3. SDK herunterladen und installieren:
   1. So laden Sie das SDK vom Unreal Engine Marketplace herunter und installieren es:
      1. Wechseln Sie zur SDK-Seite auf dem Unreal Engine Marketplace.
      2. Klicken Sie auf Open in Launcher.

1. 1. 3. Wechseln Sie zum Epic Games Launcher.

1. 1. 4. Klicken Sie auf Install to Engine.
      5. Öffnen Sie Ihr Unreal Engine-Projekt in Unreal Editor.
      6. Navigieren Sie zu Settings > Plugins > Installed > Xsolla SDK. Aktivieren Sie das Kontrollkästchen Enabled, und klicken Sie auf Restart Now, um die Einstellungen zu speichern und Unreal Editor neu zu starten.

1. 2. So laden Sie das SDK von GitHub herunter und installieren es:
      1. Laden Sie das Archiv mit dem SDK für Ihre Engine-Version herunter.
      2. Entpacken Sie das Archiv.
      3. Verschieben Sie den SDK-Ordner in das Verzeichnis plugins im Stammverzeichnis Ihres Unreal Engine-Projekts.

4. Navigieren Sie zu Settings > Project Settings > Plugins > Xsolla Settings > General.
5. Geben Sie im Feld Project ID die Projekt-ID an. Diese wird im Kundenportal neben dem Namen Ihres Projekts angezeigt.

Katalog aufseiten des Anwendungs-Clients anzeigen

Klasse für Katalogartikel erstellen

1. Navigieren Sie im Content Browser zum Verzeichnis Content.
2. Rufen Sie das Kontextmenü auf, und wählen Sie Blueprint Class aus.

3. Wählen Sie im Abschnitt All Classes die Option Object aus, und klicken Sie auf Select.

4. Vergeben Sie StoreItemData als Klassennamen.
5. Öffnen Sie den Blueprint der erstellten Klasse.
6. Klicken Sie im My Blueprint-Fenster auf Add New, und wählen Sie Variable aus.
7. Gehen Sie im Details-Fenster wie folgt vor:

1. 1. Wählen Sie im Feld Variable Type die Option StoreItem aus.
   2. Aktivieren Sie die Kontrollkästchen Instance Editable und Expose on Spawn.

8. Speichern und schließen den Blueprint StoreItemData.

Katalogartikel-Widget erstellen

1. Navigieren Sie im Content Browser zum Verzeichnis Content. Rufen Sie das Kontextmenü auf, und wählen Sie User Interface > Widget Blueprint aus.
2. Vergeben Sie StoreItem als Blueprint-Namen.
3. Öffnen Sie den erstellten Blueprint.
4. Rufen Sie im Hierarchy-Fenster das Kontextmenü für das Element CanvasPanel auf. Wählen Sie Replace With > Overlay aus.

5. Platzieren Sie die UI-Primitives aus dem Palette-Fenster wie unten abgebildet. Für das Bild, den Titel und die Beschreibung eines Artikels müssen Sie das Kontrollkästchen Is Variable im Details-Fenster markieren.

6. Öffnen Sie die Graph-Anzeige.
7. Klicken Sie auf Class settings.
8. Navigieren Sie im Details-Fenster zu Interfaces > Implemented Interfaces.
9. Klicken Sie auf Add, und wählen Sie UserObjectListEntry aus. Dabei handelt es sich um eine standardmäßige UE-Benutzeroberfläche, die es dem UI-Primitive gestattet, ein für das Listenelement normales Verhalten zu implementieren.

10. Fügen Sie die Logik für das Ereignis OnListItemObjectSet hinzu:
    1. Rufen Sie im My Blueprint-Fenster das Kontextmenü für den Abschnitt Interfaces auf, und wählen Sie Implement event aus.

1. 2. Fügen Sie die Knoten wie unten abgebildet hinzu:

11. Speichern und schließen den Blueprint StoreItem.

Widget für Katalogseite erstellen

1. Navigieren Sie im Content Browser zum Verzeichnis Content, und wählen Sie im Kontextmenü User Interface > Widget Blueprint aus.
2. Vergeben Sie WBP_Store als Namen für den Blueprint.
3. Öffnen Sie den erstellten Blueprint.
4. Fügen Sie im Artikelanzeigebereich das Element List View hinzu, und vergeben Sie StoreListView als Namen.

5. Wählen Sie im Details-Fenster im Feld Entry Widget Class die zuvor für den Artikel erstellte Klasse (StoreItem) aus.
6. Wechseln Sie zur Graph-Ansicht.
7. Binden Sie den SDK-Methodenaufruf GetVirtualItems an den EventConstruct-Knoten, wie in der folgenden Abbildung gezeigt.

8. Klicken Sie im My Blueprint-Fenster auf Add New, und wählen Sie Variable aus.
9. Gehen Sie im Details-Fenster wie folgt vor:
   1. Wählen Sie im Feld Variable Type die Option String aus.
   2. Aktivieren Sie die Kontrollkästchen Instance Editable und Expose on Spawn.
   3. Vergeben Sie PlayFabId als Namen.

10. Speichern und schließen Sie das WBP_Store-Widget.
11. Für Sie eine Logik für die Verzeichnisanzeige hinzu. Nachfolgend sehen Sie ein Beispiel für die Implementierung der Verzeichnisanzeige nach erfolgreicher Benutzerauthentifizierung.

Artikelverkauf einrichten

Um eine Bestellung mit Nutzer- und Artikeldaten bei Xsolla anzulegen, müssen Sie das Projekt um eine Cloud-Funktion ergänzen, die den API-Aufruf Zahlungstoken für den Kauf erstellen verwendet. Dieser Aufruf gibt einen Zahlungstoken zurück. Dieser ist erforderlich, um das Zahlungsportal zu öffnen und einen Kauf zu tätigen.

Einschränkungen:

• Sie müssen entweder das Land des Nutzers oder die dessen IP-Adresse übermitteln, wenn Sie den Zahlungstoken anfordern.
• Wenn Sie keine Währung im Token angeben, bestimmt das Land die Währung.
• Wenn Sie die Währung im Token angeben, zahlt der Nutzer in dieser Währung.

Cloud-Skript Ihrem Projekt hinzufügen

1. Öffnen Sie Visual Studio Code, und navigieren Sie zur Registerkarte Azure.
2. Klicken Sie unter Workspace auf das +-Symbol, und wählen Sie Create Function aus.

3. Wählen Sie das neue Projektverzeichnis aus. Es erscheint ein Menü zum Erstellen eines neuen Projekts mit einer Auswahl an Einstellungen.

4. Legen Sie die neuen Projekteinstellungen fest:
   1. Wählen Sie eine Sprache für Ihr Funktionsprojekt aus – JavaScript.
   2. Wählen Sie ein JavaScript-Programmiermodell aus – model V4.
   3. Wählen Sie eine Vorlage für die erste Funktion Ihres Projekts aus  – HTTP trigger.
   4. Vergeben Sie einen Funktionsnamen – getXsollaPaymentToken.
   5. Wählen Sie aus, wie Ihr Projekt geöffnet werden soll – Open in current window.

1. Daraufhin generiert Visual Studio Code ein JS-Projekt und öffnet die generierte Datei getXsollaPaymentToken.js.

5. Modifizieren Sie die Datei getXsollaPaymentToken.js:

const { app } = require('@azure/functions');

const projectId = ""; //your xsolla project id from publisher account
const apiKey = ""; your api key from publisher account

app.http('getXsollaPaymentToken', {
    methods: ['POST'],
    authLevel: 'anonymous',
    handler: async (request, context) => {

      var body = await request.json();

      const userId = body.uid;
      const email = body.email;
      const sku = body.sku;
      const returnUrl = body.returnUrl;

        if (!userId) {
          return {status: 400, body: 'Request body is missing' };
        }

        const payload = {
            user: {
              id: {value: userId},
              name: {
                value: email
              },
              email: {
                value: email
              },
              country: {
                value: 'US',
                allow_modify: false
              }
            },
            purchase: {
              items: [
                {
                  sku: sku,
                  quantity: 1
                }
              ]
            },
            sandbox: true,
            settings: {
              language: 'en',
              currency: 'USD',
              return_url: returnUrl,
              ui: {
                theme: '63295aab2e47fab76f7708e3'
              }
            }
          }

        let url = "https://store.xsolla.com/api/v2/project/" + projectId.toString() + "/admin/payment/token";

        return fetch(
            url,
            {
                method: "POST",
                headers: {
                'Content-Type': 'application/json',
                Authorization: 'Basic ' + btoa(`${projectId}:${apiKey}`)
                },
                body: JSON.stringify(payload)
            },
            )
            .then(xsollaRes => {
            // Handle the response data
                if (xsollaRes.ok) {
                    return xsollaRes.json();
                } else {
                    return { status: 400, body: `HTTP request failed with error: ${xsollaRes.statusText}` };
                }
            })
            .then(data => {
                return { status: 200, body: JSON.stringify(data) };
            })
            .catch(error => {
                return { status: 501, body: `Error = ${error}` };
            });
        }
});

1. Geben Sie in dem Skript die Werte für die Konstanten an:

1. • PROJECT_ID – Projekt-ID, diese wird im Kundenportal neben dem Projektnamen angezeigt.

1. • API_KEY – API-Schlüssel. Wird im Kundenportal nur einmal angezeigt, nämlich dann, wenn er erstellt wird. Sie sind selbst dafür verantwortlich, den Schlüssel zu speichern. Einen neuen Schlüssel können Sie in den folgenden Abschnitten erstellen:
     • Firmeneinstellungen > API-Schlüssel
     • Projekteinstellungen > API-Schlüssel

Nachdem Sie das Cloud-Skript hinzugefügt haben, können Sie den Aufruf der Funktion getXsollaPaymentToken lokal testen.

Cloud-Skript bereitstellen

1. Navigieren Sie in Visual Studio Code zu Azure > Resources, und klicken Sie auf das +-Symbol.
2. Wählen Sie Create Function App in Azure als Ressource aus. Es erscheint ein Menü zum Erstellen einer neuen Anwendung mit einer Auswahl an Einstellungen.
3. Legen Sie die Anwendungseinstellungen fest:

1. 1. Benennen Sie die neue Funktions-App – XsollaFunctions.
   2. Wählen Sie einen Laufzeit-Stack aus – .NET 8 Isolated.
   3. Wählen Sie einen Ort für neue Ressourcen aus (Sie können eine beliebige Option auswählen).

1. Warten Sie, bis die Ressourcengruppe erstellt ist.

4. Wählen Sie in der Liste der Ressourcen die Option XsollaFunctions aus, öffnen Sie das Kontextmenü, und wählen Sie Deply to Function App aus.

Nachdem Sie das Cloud-Skript hinzugefügt haben, können Sie den Aufruf der Funktion getXsollaPaymentToken remote testen.

Cloud-Skript testen

Rufen Sie die Funktion getXsollaPaymentToken mit Postman oder einem anderen Tool auf, um das Cloud-Skript (lokal oder remote) zu testen. Gehen Sie dazu wie folgt vor:

1. Navigieren Sie in Visual Studio Code zu Azure > Workspace > Local Project > Functions, und klicken Sie auf Start debugging to update this list.
2. Öffnen Sie das Kontextmenü für die Funktion , und wählen Sie Copy Function Url aus. Erfolgt der Test lokal, sieht die URL wie folgt aus – http://localhost:7071/api/getXsollaPaymentToken. Erfolgt der Test remote, sieht die URL wie folgt aus – https://xsollafunctions.azurewebsites.net/api/GetXsollaPaymentToken.

3. Verwenden Sie die kopierte URL, um die Funktion mit den angegebenen Parametern aufzurufen. So rufen Sie eine Funktion aus Postman auf:
   1. Erstellen Sie eine neue GET-Anfrage.
   2. Geben Sie die in Schritt 2 kopierte URL an.
   3. Wechseln Sie zur Registerkarte Body, und geben Sie die Anfrageparameter an.

Anfragerumpf (Beispiel):

{

 "FunctionArgument": {

   "uid": "1D384D9EF12EAB8B",

   "sku": "booster_max_1",

   "returnUrl": "https://login.xsolla.com/api/blank"

 }

}

4. Klicken Sie auf Send. Die Antwort sollte ein JSON mit den folgenden Parametern enthalten:
   • token – Zahlungstoken. Ist zum Öffnen des Zahlungsportals erforderlich.
   • order_id – ID der angelegten Bestellung. Ist zum Tracken des Bestellstatus erforderlich.

Antwortrumpf (Beispiel):

{"token":"xsnpCF8tS4ox7quoibgTgPFVFxG9gTvS_lc_en_bg_2C2640_tb_6E7BF7","order_id":90288613}

Funktion für den Abruf eines Zahlungstokens in PlayFab registrieren

1. Öffnen Sie Ihr Projekt in PlayFab.
2. Klicken Sie in der Seitenleiste auf Automation.
3. Klicken Sie unter Register New Cloud Script Function auf Register Function.
4. Benennen Sie die Funktion – GetXsollaPaymentToken.
5. Fügen Sie die Funktions-URL ein, die Sie in Visual Code Studio kopiert haben (siehe Schritte 1–2 unter Cloud-Skript testen).

Bestellung anlegen und Zahlungsportal im Unreal Engine-Projekt öffnen

1. Öffnen Sie Ihr Unreal Engine-Projekt.
2. Öffnen Sie das WBP_Store-Widget.
3. Wählen Sie im Hierarchy-Fenster die Option StoreListView aus.
4. Klicken Sie im Details-Fenster auf das +-Symbol neben dem Ereignis On Clicked.

5. Wechseln Sie zur Graph-Ansicht.
6. Fügen Sie eine Logik hinzu, gemäß der das PlayfabJsonObject-Objekt erstellt wird, und übermitteln Sie die Daten an dieses Objekt, um eine Bestellung am OnItemClicked-Knoten anzulegen, wie unten abgebildet:

7. Fügen Sie der Methode ExecuteFunction einen Aufruf hinzu. Übermitteln Sie beim dem Aufruf die Parameter functionName = getXsollaPaymentToken und FunctionParameter = PlayfabJsonObject.

Bestellstatus-Tracking einrichten

Der Bestellstatus muss getrackt werden, um sicherzustellen, dass die Zahlung erfolgreich war, und um dem Nutzer die entsprechenden Artikel zu gewähren.

Bestellstatus clientseitig abrufen

Tracken Sie den Bestellstatus mithilfe der SDK-Methode CheckPendingOrder im Anwendungs-Client. Übermitteln Sie der Methode die folgenden Parameter:

• AuthToken – Benutzerauthentifizierungstoken
• OrderId – Bestell-ID, erhalten beim Kauf über den Warenkorb, beim One-Click-Kauf oder beim Kauf gegen virtuelle Währung
• SuccessCallback – Rückruf für den Fall, dass sich der Bestellstatus in “done” ändert
• ErrorCallback – Rückruf für den Fall, dass der Xsolla-Server einen Fehler meldet

Ausführliche Informationen dazu, wie die Methoden funktionieren, finden Sie im Abschnitt Bestellstatus tracken.

Bestellstatus serverseitig abrufen

So konfigurieren Sie Webhooks bei Xsolla:

1. Öffnen Sie Ihr Projekt im Kundenportal.
2. Klicken Sie in der Seitenleiste auf Projekteinstellungen, und navigieren Sie zur Registerkarte Webhooks.
3. Geben Sie im Feld Webhook-Server die URL ein, an die Xsolla die Webhooks senden soll.

4. Kopieren und speichern Sie den Wert aus dem Feld Geheimer Schlüssel. Dieser Schlüssel wird standardmäßig generiert und dient dazu, Webhooks zu signieren. Wenn Sie ihn ändern möchten, klicken Sie auf das Aktualisieren-Symbol.
5. Klicken Sie auf Webhooks aktivieren.