Comment intégrer Pay Station avec l’authentification PlayFab

Après avoir implémenté l’authentification utilisateur via PlayFab dans votre application, générez un jeton de paiement côté PlayFab, puis passez-le au client de l’application pour ouvrir l’interface de paiement.

Cette option d’intégration implique l’implémentation indépendante de la logique pour déterminer le pays de l’utilisateur et la devise de paiement.

Flux d’intégration :

1. Créez un projet.

1. Inscrivez un Compte éditeur et créez un nouveau projet. L'ID du projet créé sera nécessaire aux étapes suivantes.

2. Configurez un catalogue :
   • Créez un catalogue des objets côté Xsolla. Ajoutez des objets manuellement ou importez-les depuis Google Play ou PlayFab.
   • En utilisant le SDK, implémentez la récupération et l'affichage du catalogue côté client de l'application.

3. Configurez l'achat d'un objet :
   • À l'aide d'un script cloud PlayFab, créez une commande avec les données utilisateur et les données de l'objet côté client de l'application.
   • Implémentez l'ouverture de l'interface de paiement côté client de l'application en utilisant le SDK.

4. Implémentez le suivi de l'état de la commande.

Créer un projet

S'inscrire au Compte éditeur

Le Compte éditeur est l’outil principal pour configurer les fonctionnalités Xsolla, ainsi que pour gérer les analyses et les transactions.

Les informations relatives à votre entreprise et à votre application fournies lors de l’inscription seront utilisées pour créer un projet de contrat de licence avec Xsolla et pour générer des recommandations sur les solutions adaptées à vos besoins. Bien que vous puissiez modifier ces informations ultérieurement, les fournir correctement lors de l’inscription accélérera le processus de signature du contrat de licence.

Pour vous inscrire, accédez au Compte éditeur et créez un compte.

Créer un projet dans le Compte éditeur

Si vous gérez plusieurs applications, nous vous recommandons de créer un projet distinct pour chacune d’entre elles. En fonction des informations fournies lors de la création du projet, Xsolla génère des recommandations adaptées à vos besoins.

Pour créer un nouveau projet :

1. Ouvrez votre Compte éditeur.
2. Dans le menu latéral, cliquez sur Create project.

3. Entrez le nom de votre projet en anglais (obligatoire).

4. Sélectionnez un ou plusieurs plateformes de sortie pour votre jeu (obligatoire).
5. Ajoutez un lien vers votre jeu. Si votre jeu n'a pas encore de site Web, ajoutez un lien vers une ressource contenant des informations sur le jeu (obligatoire).
6. Choisissez le moteur de jeu.
7. Sélectionnez les options de monétisation que vous utilisez ou prévoyez d'utiliser.
8. Spécifiez si le jeu est déjà publié. Si le jeu n'a pas encore été publié, indiquez la date de sortie prévue.
9. Cliquez sur Create project.

Au cours du processus d’intégration, vous devez fournir l’ID de projet. Il se trouve dans le Compte éditeur à côté du nom du projet.

Configurer le catalogue

Créer des objets dans le Compte éditeur

Pour ajouter un objet virtuel avec des paramètres de base au catalogue :

1. Ouvrez le projet dans le Compte éditeur.
2. Dans le menu latéral, cliquez sur Store.
3. Dans le volet Virtual Items, cliquez sur Connect.
4. Dans le menu déroulant, sélectionnez Create item.

5. Configurez les paramètres de base de l'objet dans les champs suivants :
   • Image (facultatif) ;
   • SKU (ID unique de l'objet) ;
   • Item name ;
   • Description (facultatif).

6. Spécifiez le prix de l'objet :
   1. Réglez la bascule Price in real currency sur On.
   2. Dans le champ Default currency, modifiez la devise (facultatif) et spécifiez le prix de l'objet.
   3. Si vous avez changé la devise dans le champ Default currency, sélectionnez la même devise dans le champ Price in real currency.

7. Changez le statut de l'objet en Available.

8. Cliquez sur Create item.

Installer et configurer le SDK

1. Téléchargez le lanceur Epic Games.
2. Créez un nouveau projet Unreal Engine.

3. Téléchargez et installez le SDK :
   1. Pour télécharger et installer le SDK depuis l'Unreal Engine Marketplace :
      1. Accédez à la page du SDK sur l'Unreal Engine Marketplace.
      2. Cliquez sur Open in Launcher.

1. 1. 3. Accédez au lanceur Epic Games.

1. 1. 4. Cliquez sur Install to Engine.
      5. Ouvrez votre projet Unreal Engine dans l'éditeur Unreal.
      6. Accédez à la section Settings > Plugins > Installed > Xsolla SDK. Cochez la case Enabled et cliquez sur Restart Now pour enregistrer les paramètres et recharger l'éditeur Unreal.

1. 2. Pour télécharger et installer le SDK depuis GitHub :
      1. Téléchargez le package avec le SDK pour votre version du moteur.
      2. Décompressez le package.
      3. Déplacez le dossier du SDK dans le répertoire plugins à la racine de votre projet Unreal Engine.

4. Accédez à Settings > Project Settings > Plugins > Xsolla Settings > General.
5. Dans le champ Project ID, spécifiez l'ID du projet qui se trouve dans le Compte éditeur à côté du nom de votre projet.

Afficher le catalogue côté client de l'application

Créer un catalogue des objets

1. Dans Content Browser, accédez au répertoire Content.
2. Appelez le menu contextuel et sélectionnez Blueprint Class.

3. Dans la section All Classes, sélectionnez Object et cliquez sur Select.

4. Spécifiez StoreItemData comme nom de la classe.
5. Ouvrez le blueprint de la classe créée.
6. Dans le panneau My Blueprint, cliquez sur Add New et sélectionnez Variable.
7. Dans le panneau Details :

1. 1. Spécifiez StoreItem dans le champ Variable Type ;
   2. Cochez les cases Instance Editable et Expose on Spawn.

8. Enregistrez et fermez le blueprint StoreItemData.

Créer un widget pour un objet du catalogue

1. Dans Content Browser, accédez au répertoire Content. Appelez le menu contextuel et sélectionnez User Interface > Widget Blueprint.
2. Spécifiez StoreItem comme nom du blueprint.
3. Ouvrez le blueprint créé.
4. Dans le panneau Hierarchy, appelez le menu contextuel pour l'élément CanvasPanel. Sélectionnez Replace With > Overlay.

5. Disposez les primitives d'interface depuis le panneau Palette, comme illustré ci-dessous. Pour l'image, le titre et la description d'un élément, cochez la case Is Variable dans le panneau Details.

6. Ouvrez une vue Graph.
7. Cliquez sur Class settings.
8. Dans le panneau Details, accédez à Interfaces > Implemented Interfaces.
9. Cliquez sur Add et sélectionnez UserObjectListEntry. Il s'agit d'une interface UE standard qui permet à la primitive d'interface d'implémenter un comportement normal pour l'élément de la liste.

10. Ajoutez la logique pour l'événement OnListItemObjectSet :
    1. Dans le panneau My Blueprint, ouvrez le menu contextuel pour la section Interfaces et sélectionnez Implement event ;

1. 2. Ajoutez des nœuds comme illustré ci-dessous :

11. Enregistrez et fermez le blueprint StoreItem.

Créer un widget de page de catalogue

1. Dans Content Browser, accédez au répertoire Content et sélectionnez User Interface > Widget Blueprint dans le menu contextuel.
2. Spécifiez WBP_Store en tant que nom du blueprint.
3. Ouvrez le blueprint créé.
4. Dans la zone d'affichage des éléments, ajoutez l'élément List View et nommez-le StoreListView.

5. Dans le panneau Details, dans le champ Entry Widget Class, sélectionnez la classe précédemment créée pour l'élément (StoreItem).
6. Accédez à la vue Graph.
7. Liez l'appel à la méthode SDK GetVirtualItems au nœud EventConstruct, comme illustré dans la figure ci-dessous.

8. Dans le panneau My Blueprint, cliquez sur Add New et sélectionnez Variable.
9. Dans le panneau Details :
   1. Dans le champ Variable Type, sélectionnez String ;
   2. Cochez les cases Instance Editable et Expose on Spawn ;
   3. Spécifiez PlayFabId comme nom.

10. Enregistrez et fermez le widget WBP_Store.
11. Ajoutez la logique d'affichage du répertoire. Voici un exemple d'implémentation de l'affichage du répertoire après l'authentification réussie de l'utilisateur.

Configurer l'achat d'objets

Pour créer une commande avec les données utilisateur et les données de l’objet côté Xsolla, ajoutez une Cloud Function au projet qui utilise l’appel API Create payment token for purchase. Cet appel renverra un jeton de paiement, nécessaire pour ouvrir l’interface de paiement et effectuer un achat.

Limites :

• Lors de la demande du jeton de paiement, vous devez passer soit le pays de l’utilisateur, soit l’adresse IP.
• Si vous ne passez pas la devise dans le jeton, elle se détermine en fonction du pays.
• Si vous passez la devise dans le jeton, l’utilisateur paie dans cette devise.

Ajouter un script cloud à votre projet

1. Ouvrez Visual Studio Code et accédez à l'onglet Azure.
2. Dans la section Workspace, cliquez sur l'icône + et sélectionnez Create Function.

3. Sélectionnez le répertoire du nouveau projet. Un menu permettant de créer un nouveau projet s'affiche avec une sélection de paramètres.

4. Spécifiez les nouveaux paramètres du projet :
   1. Sélectionnez une langue pour votre projet de fonction — JavaScript.
   2. Sélectionnez un modèle de programmation JavaScript — model V4.
   3. Sélectionnez un modèle pour la première fonction de votre projet — HTTP trigger.
   4. Entrez un nom de fonction — getXsollaPaymentToken.
   5. Sélectionnez la manière dont vous souhaitez ouvrir le projet — Open in current window.

1. En conséquence, Visual Studio Code générera un projet JS et ouvrira le fichier getXsollaPaymentToken.js généré.

5. Modifiez le fichier 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. Dans le script, spécifiez les valeurs des constantes :

1. • PROJECT_ID — l'ID du projet, qui se trouve dans le Compte éditeur à côté du nom du projet.

1. • API_KEY – Clé API. Elle ne s'affiche dans le Compte éditeur qu'une seule fois lors de sa création, vous devez donc la conserver de votre côté. Vous pouvez créer une nouvelle clé dans les sections suivantes :
     • Company settings > API keys ;
     • Project settings > API keys.

Après avoir ajouté le script cloud, vous pouvez tester l’appel de la fonction getXsollaPaymentToken localement.

Déployer un script cloud

1. Dans Visual Studio Code, accédez à la section Azure > Resources et cliquez sur l'icône +.
2. Sélectionnez Create Function App in Azure en tant que ressource. Un menu pour la création d'une nouvelle application s'affiche avec une sélection de paramètres.
3. Définissez les paramètres de l'application :

1. 1. Entrez le nom de la nouvelle application de fonction — XsollaFunctions ;
   2. Sélectionnez une pile d'exécution — .NET 8 Isolated ;
   3. Sélectionnez un emplacement pour les nouvelles ressources (vous pouvez choisir n'importe quelle option).

1. Attendez que le groupe de ressources soit créé.

4. Dans la liste des ressources, sélectionnez XsollaFunctions, appelez le menu contextuel et choisissez Deply to Function App.

Après avoir ajouté le script cloud, vous pouvez tester l’appel de la fonction getXsollaPaymentToken à distance.

Tester un script cloud

Pour tester le script cloud (en local ou à distance), appelez la fonction getXsollaPaymentToken à l’aide de Postman ou d’un autre outil. Pour ce faire :

1. Dans Visual Studio Code, accédez à la section Azure > Workspace > Local Project > Functions et cliquez sur Start debugging to update this list.
2. Appelez le menu contextuel pour la fonction et sélectionnez Copy Function Url. Lors des tests en local, l'URL ressemblera à ceci — http://localhost:7071/api/getXsollaPaymentToken. Lors des tests à distance — https://xsollafunctions.azurewebsites.net/api/GetXsollaPaymentToken.

3. Utilisez l'URL copiée pour appeler la fonction avec les paramètres spécifiés. Pour appeler une fonction depuis Postman :
   1. Créez une nouvelle requête GET ;
   2. Fournissez l'URL que vous avez copiée à l'étape 2 ;
   3. Accédez à l'onglet Body et spécifiez les paramètres de la requête.

Exemple de corps de la requête :

{

 "FunctionArgument": {

   "uid": "1D384D9EF12EAB8B",

   "sku": "booster_max_1",

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

 }

}

4. Cliquez sur Send. Dans la réponse, vous devriez recevoir du contenant les paramètres suivants :
   • token — jeton de paiement. Nécessaire pour ouvrir l'interface de paiement ;
   • order_id — ID de la commande créée. Nécessaire pour suivre le statut de la commande.

Exemple de corps de la réponse :

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

Fonction d'enregistrement pour obtenir un jeton de paiement dans PlayFab

1. Ouvrez votre projet dans PlayFab.
2. Dans le menu latéral, cliquez sur Automation.
3. Dans la section Register New Cloud Script Function, cliquez sur Register Function.
4. Entrez le nom de la fonction — GetXsollaPaymentToken.
5. Entrez l'URL de la fonction que vous avez copiée dans Visual Studio Code (voir étapes 1-2 de Tester un script cloud).

Créer une commande et ouvrir l'interface de paiement dans le projet Unreal Engine

1. Ouvrez votre projet Unreal Engine.
2. Ouvrez le widget WBP_Store.
3. Dans le panneau Hierarchy, sélectionnez StoreListView.
4. Dans le panneau Details, cliquez sur l'icône + à côté de l'événement On Clicked.

5. Accédez à la vue Graph.
6. Ajoutez la logique pour créer un objet PlayfabJsonObject et pour passer les données au nœud OnItemClicked en vue de création d'une commande, comme illustré ci-dessous :

7. Ajoutez un appel à la méthode ExecuteFunction. Passez-lui les paramètres functionName = getXsollaPaymentToken et FunctionParameter = PlayfabJsonObject.

Configurer le suivi de l'état de la commande

Le suivi de l’état de la commande est requis pour s’assurer de la réussite du paiement et pour octroyer les objets à l’utilisateur.

Obtenir l'état de la commande côté client

Pour suivre les modifications du statut de la commande, utilisez la méthode SDK CheckPendingOrder. Passez les paramètres suivants à la méthode :

• AuthToken — jeton d’autorisation utilisateur ;
• OrderId — ID de commande reçu depuis achat via le panier, achat en un clic ou achat contre de la monnaie virtuelle ;
• SuccessCallback — fonction de rappel appelée si le statut de la commande passe à done ;
• ErrorCallback — fonction de rappel appelée si le serveur Xsolla renvoie une erreur.

Pour des informations détaillées sur le fonctionnement de la méthode, consultez la section Track order status.

Obtenir l'état de la commande côté serveur

Pour configurer les webhooks côté Xsolla :

1. Ouvrez le projet dans le Compte éditeur.
2. Dans le menu latéral, cliquez sur Project settings et accédez à la section Webhooks.
3. Dans le champ Webhook server, entrez l’URL vers laquelle Xsolla enverra les webhooks.

4. Copiez et enregistrez la valeur du champ Secret key. Cette clé générée par défaut s'utilise pour signer les webhooks. Si vous souhaitez la modifier, cliquez sur l'icône de mise à jour.
5. Cliquez sur Enable webhooks.