Comment intégrer Pay Station avec l’authentification Firebase
Après avoir implémenté l’authentification utilisateur via Firebase dans votre application, générez un jeton de paiement côté Firebase, 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 :
- Inscrivez un Compte éditeur et créez un nouveau projet. L'ID du projet créé sera nécessaire aux étapes suivantes.
- 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.
- Configurez l'achat d'un objet :
- À l'aide de Cloud Functions Firebase, 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.
Pour compléter l’intégration et commencer à accepter les paiements réels, vous devez signer un contrat de licence avec Xsolla.
Vous pouvez signer le contrat de licence à n’importe quelle étape de l’intégration, mais gardez à l’esprit que le processus d’examen peut prendre jusqu’à trois jours ouvrables.
Utilisez le modèle de l’application comme référence pour implémenter l’intégration de l’authentification Firebase avec Pay Station. Le code source du modèle se trouve sur GitHub.
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.
Le mot de passe du Compte éditeur peut comprendre des lettres latines, des chiffres et des caractères spéciaux et doit contenir au moins :
- 8 caractères ;
- un chiffre ;
- une lettre majuscule ;
- une lettre minuscule.
Pour garantir la sécurité du mot de passe, nous recommandons de :
- changer de mot de passe au moins tous les 90 jours ;
- créer un nouveau mot de passe différent aux 4 derniers mots de passe utilisés pour votre compte ;
- créer un mot de passe unique différent des mots de passe utilisés ailleurs ;
- ne pas conserver votre mot de passe dans un endroit où il est facilement accessible ;
- utiliser des gestionnaires de mots de passe pour stocker votre mot de passe.
Le Compte éditeur utilise une authentification à deux facteurs, qui consiste à envoyer un code de confirmation à chaque tentative d’authentification.
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 :
- Ouvrez votre Compte éditeur.
- Dans le menu latéral, cliquez sur Create project.
- Entrez le nom de votre projet en anglais (obligatoire).
- Sélectionnez un ou plusieurs plateformes de sortie pour votre jeu (obligatoire).
- 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).
- Choisissez le moteur de jeu.
- Sélectionnez les options de monétisation que vous utilisez ou prévoyez d'utiliser.
- 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.
- 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 ce faire, créez un catalogue côté Xsolla. Ajoutez des objets manuellement ou importez-les depuis Google Play ou PlayFab. Notez que vous pouvez importer un maximum de 100 objets à la fois depuis Google Play.
Ces instructions décrivent les étapes de la configuration de base d’un objet virtuel. Par la suite, vous pourrez ajouter d’autres objets au catalogue (monnaie virtuelle, lots, clés de jeu), créer des groupes d’objets, configurer des campagnes promotionnelles, des prix régionaux, etc.
Pour ajouter un objet virtuel avec des paramètres de base au catalogue :
- Ouvrez le projet dans le Compte éditeur.
- Dans le menu latéral, cliquez sur Store.
- Dans le volet Virtual Items, cliquez sur Connect.
- Dans le menu déroulant, sélectionnez Create item.
- 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).
- Spécifiez le prix de l'objet :
- Réglez la bascule Price in real currency sur On.
- Dans le champ Default currency, modifiez la devise (facultatif) et spécifiez le prix de l'objet.
- Si vous avez changé la devise dans le champ Default currency, sélectionnez la même devise dans le champ Price in real currency.
- Changez le statut de l'objet en Available.
- Cliquez sur Create item.
Afficher le catalogue côté client de l'application
- Téléchargez le SDK depuis CDN ou GitHub.
- Décompressez le package.
- Dans le menu principal, accédez à
Assets > Import Package > Custom Package et sélectionnez le SDK téléchargé. - Dans le menu principal, allez à
Window > Xsolla > Edit Settings . - Accédez au panneau
Inspector . Dans le champProject ID , spécifiez l'ID du projet, qui se trouve dans le Compte éditeur à côté du nom de votre projet.
- Côté client de l'application, ajoutez une interface pour afficher le catalogue des objets.
- Implémentez la demande du catalogue des objets depuis les serveurs Xsolla.
Pour obtenir une liste d’objets virtuels, utilisez la méthode SDK GetCatalog
. Vous pouvez également utiliser d’autres méthodes SDK pour récupérer les informations sur les objets du catalogue.
Pour un tutoriel étape par étape sur la création d’une page de catalogue, consultez Affichage du catalogue des objets.
Configurer l'achat d'objets
Créer une commande à l'aide d'une Cloud Function
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.
Pour ajouter une Cloud Fonction à un projet :
- Installez l'interface CLI (Command-Line Interface) de Firebase. Pour ce faire, exécutez la commande CLI :
npm install -g firebase-tools
- Pour lier votre projet au projet Firebase, initialisez le projet Firebase en exécutant la commande CLI :
firebase init functions
- Suivez les instructions de l'installateur pour configurer les paramètres :
- Sélectionnez une base de code existante ;
- Spécifiez JavaScript comme langage pour créer des Cloud Functions.
- Installez les dépendances.
- Ouvrez le fichier
functions/index.js
et modifiez-le :
- javascript
// The Cloud Functions for Firebase SDK to create Cloud Functions and triggers.
const functions = require('firebase-functions/v1');
const projectId = <projectId>;
const apiKey = <apiKey>;
exports.getXsollaPaymentToken = functions.https.onRequest((req, res) => {
const requestBody = req.body;
if (!requestBody) {
res.status(400).send('Request body is missing');
return;
}
const userId = requestBody.data.uid;
const email = requestBody.data.email;
const sku = requestBody.data.sku;
const returnUrl = requestBody.data.returnUrl;
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/v3/project/" + projectId.toString() + "/admin/payment/token";
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 {
throw new Error(`HTTP request failed with status ${xsollaRes.status} and statusText: ${xsollaRes.statusText}`)
}
})
.then(data => {
res.send(JSON.stringify(data));
})
.catch(error => {
res.send("Error = " + error);
});
});
exports.webhookFakeResponse = functions.https.onRequest((request, response) => {
response.status(200).send()
})
- Dans le script, spécifiez les valeurs pour les variables :
projectId
— l'ID du projet, qui se trouve dans le Compte éditeur à côté du nom du projet.
apiKey
– 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.
- Pour tester la Cloud Function avec l'émulateur, exécutez la commande CLI :
firebase emulators:start
- Après avoir exécuté la Cloud Function, vous pouvez appeler les méthodes suivantes côté client de l'application :
getXsollaPaymentToken
— renvoie le jeton de paiement pour ouvrir l'interface de paiement ;webhookFakeResponse
— envoie le code HTTP200
en réponse au webhook Paiement. La méthode ne contient pas de logique de validation d'achat : utilisez-la uniquement à des fins de test. Pour accéder à la liste complète des webhooks et obtenir des informations générales sur leur utilisation, consultez la documentation sur les webhooks.
- Pour appeler les méthodes localement, utilisez les URL suivantes :
https://localhost:5001/{firebase-project-id}/us-central1/getXsollaPaymentToken
ethttps://localhost:5001/{firebase-project-id}/us-central1/webhookFakeResponse
, où{firebase-project-id}
est l'ID du projet Firebase (Firebase console > Project Settings > Project ID).
- Pour déployer la Cloud Function en production, exécutez la commande CLI :
firebase deploy --only functions
- Une fois le déploiement en production effectué, vous pouvez appeler les méthodes via les URL
https://us-central1-{firebase-project-id}.cloudfunctions.net/getXsollaPaymentToken
ethttps://us-central1-{firebase-project-id}.cloudfunctions.net/webhookFakeResponse
, où{firebase-project-id}
est l'ID du projet Firebase (Firebase console > Project Settings > Project ID). Pour plus de détails sur l'exécution de cette fonctionnalité en production, consultez la documentation Firebase.
Créer une commande et ouvrir l'interface de paiement dans le projet Unity
- Ouvrez votre projet Unity.
- Apportez des modifications au script du contrôleur de page :
- Ajoutez la méthode
MakeCloudFunctionRequest
pour appeler Cloud Functions. Pour appeler la méthodegetXsollaPaymentToken
, fournissez l'une des URL suivantes, où{firebase-project-id}
est l'ID du projet Firebase (Firebase console > Project Settings > Project ID):
- Ajoutez la méthode
- pour un accès local —
https://localhost:5001/{firebase-project-id}/us-central1/getXsollaPaymentToken
, - pour un accès en production —
https://us-central1-{firebase-project-id}.cloudfunctions.net/getXsollaPaymentToken
;
- pour un accès local —
- C++
IEnumerator MakeCloudFunctionRequest(string sku)
{
string url = "https://localhost:5001/{firebase-project-id}/us-central1/getXsollaPaymentToken";
using (UnityWebRequest webRequest = UnityWebRequest.Get(url))
{
var userData = new UserData()
{
data = new UserData.Data() {
uid = user.UserId,
email = user.Email,
sku = sku,
returnUrl = "app://xpayment.com.xsolla.unitysample"
}
};
byte[] data = System.Text.Encoding.UTF8.GetBytes(JsonUtility.ToJson(userData, true));
UploadHandlerRaw upHandler = new UploadHandlerRaw(data);
upHandler.contentType = "application/json";
webRequest.uploadHandler = upHandler;
webRequest.method = "POST";
yield return webRequest.SendWebRequest();
if (webRequest.result != UnityWebRequest.Result.Success)
{
Debug.LogError("Error: " + webRequest.error);
}
else
{
var paymentToken = "";
XsollaWebBrowser.OpenPurchaseUI(
paymentToken,
false);
Debug.Log("Response: " + webRequest.downloadHandler.text);
}
}
}
- Ajoutez l'appel à la fonction cloud de rappel en cas de clic sur le bouton d'achat :
- C++
private void OnItemsRequestSuccess(StoreItems storeItems)
{
foreach (var storeItem in storeItems.items)
{
var widgetGo = Instantiate(WidgetPrefab, WidgetsContainer, false);
var widget = widgetGo.GetComponent<StoreItemWidget>();
widget.BuyButton.onClick.AddListener(() =>
{
StartCoroutine(MakeCloudFunctionRequest(storeItem.sku));
});
widget.NameText.text = storeItem.name;
widget.DescriptionText.text = storeItem.description;
if (storeItem.price != null)
{
var realMoneyPrice = storeItem.price;
widget.PriceText.text = $"{realMoneyPrice.amount} {realMoneyPrice.currency}";
}
ImageLoader.LoadSprite(storeItem.image_url, sprite => widget.IconImage.sprite = sprite);
}
}
Utilisez le projet de test comme exemple d’implémentation. Le code source du projet Unity se trouve sur GitHub.
Exemple de script de contrôleur de page :
- C++
using Firebase.Extensions;
using System;
using System.Collections;
using UnityEngine;
using UnityEngine.Networking;
using UnityEngine.UI;
using Xsolla.Catalog;
using Xsolla.Core;
[Serializable]
public class UserData
{
public Data data;
[Serializable]
public class Data
{
public string uid;
public string email;
public string sku;
public string returnUrl;
}
}
public class FirebaseExamplePage : MonoBehaviour
{
public GameObject LoginContainer;
public GameObject StoreItemsContainer;
public InputField EmailInputField;
public InputField PasswordInputField;
public Button LoginButton;
public Button RegisterButton;
public Transform WidgetsContainer;
public GameObject WidgetPrefab;
protected Firebase.Auth.FirebaseAuth auth;
Firebase.Auth.FirebaseUser user = null;
Firebase.DependencyStatus dependencyStatus = Firebase.DependencyStatus.UnavailableOther;
public virtual void Start()
{
Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWithOnMainThread(task => {
dependencyStatus = task.Result;
if (dependencyStatus == Firebase.DependencyStatus.Available)
{
InitializeFirebase();
}
else
{
Debug.LogError(
"Could not resolve all Firebase dependencies: " + dependencyStatus);
}
});
}
protected void InitializeFirebase()
{
StoreItemsContainer.SetActive(false);
Debug.Log("Setting up Firebase Auth");
auth = Firebase.Auth.FirebaseAuth.DefaultInstance;
auth.StateChanged += AuthStateChanged;
RegisterButton.onClick.AddListener(() =>
{
auth.CreateUserWithEmailAndPasswordAsync(EmailInputField.text, PasswordInputField.text).ContinueWith(task =>
{
if (task.IsCanceled)
{
Debug.LogError("CreateUserWithEmailAndPasswordAsync was canceled.");
return;
}
if (task.IsFaulted)
{
Debug.LogError("CreateUserWithEmailAndPasswordAsync encountered an error: " + task.Exception);
return;
}
Firebase.Auth.AuthResult result = task.Result;
Debug.LogFormat("Firebase user created successfully: {0} ({1})",
result.User.DisplayName, result.User.UserId);
});
});
LoginButton.onClick.AddListener(() =>
{
auth.SignInWithEmailAndPasswordAsync(EmailInputField.text, PasswordInputField.text).ContinueWith(task =>
{
if (task.IsCanceled)
{
Debug.LogError("SignInWithEmailAndPasswordAsync was canceled.");
return;
}
if (task.IsFaulted)
{
Debug.LogError("SignInWithEmailAndPasswordAsync encountered an error: " + task.Exception);
return;
}
Firebase.Auth.AuthResult result = task.Result;
Debug.LogFormat("Firebase user logged in successfully: {0} ({1})",
result.User.DisplayName, result.User.UserId);
});
});
}
void AuthStateChanged(object sender, System.EventArgs eventArgs)
{
Firebase.Auth.FirebaseAuth senderAuth = sender as Firebase.Auth.FirebaseAuth;
if (senderAuth == auth && senderAuth.CurrentUser != user)
{
bool signedIn = user != senderAuth.CurrentUser && senderAuth.CurrentUser != null;
if (!signedIn && user != null)
{
Debug.Log("Signed out " + user.UserId);
}
user = senderAuth.CurrentUser;
if (signedIn)
{
Debug.Log("AuthStateChanged Signed in " + user.UserId);
LoadCatalog();
}
}
}
void OnDestroy()
{
if (auth != null)
{
auth.SignOut();
auth.StateChanged -= AuthStateChanged;
auth = null;
}
}
private void LoadCatalog()
{
LoginContainer.SetActive(false);
StoreItemsContainer.SetActive(true);
XsollaCatalog.GetCatalog(OnItemsRequestSuccess, OnError);
}
private void OnItemsRequestSuccess(StoreItems storeItems)
{
foreach (var storeItem in storeItems.items)
{
var widgetGo = Instantiate(WidgetPrefab, WidgetsContainer, false);
var widget = widgetGo.GetComponent<StoreItemWidget>();
if(widget != null)
{
widget.NameText.text = storeItem.name;
widget.DescriptionText.text = storeItem.description;
widget.BuyButton.onClick.AddListener(() =>
{
StartCoroutine(MakeCloudFunctionRequest(storeItem.sku));
});
if (storeItem.price != null)
{
var realMoneyPrice = storeItem.price;
widget.PriceText.text = $"{realMoneyPrice.amount} {realMoneyPrice.currency}";
}
ImageLoader.LoadSprite(storeItem.image_url, sprite => widget.IconImage.sprite = sprite);
}
}
}
IEnumerator MakeCloudFunctionRequest(string sku)
{
string url = "https://localhost:5001/{firebase-project-id}/us-central1/getXsollaPaymentToken";
using (UnityWebRequest webRequest = UnityWebRequest.Get(url))
{
var userData = new UserData()
{
data = new UserData.Data() {
uid = user.UserId,
email = user.Email,
sku = sku,
returnUrl = "app://xpayment.com.xsolla.unitysample"
}
};
byte[] data = System.Text.Encoding.UTF8.GetBytes(JsonUtility.ToJson(userData, true));
UploadHandlerRaw upHandler = new UploadHandlerRaw(data);
upHandler.contentType = "application/json";
webRequest.uploadHandler = upHandler;
webRequest.method = "POST";
yield return webRequest.SendWebRequest();
if (webRequest.result != UnityWebRequest.Result.Success)
{
Debug.LogError("Error: " + webRequest.error);
}
else
{
string responseJson = webRequest.downloadHandler.text;
var responseData = JsonUtility.FromJson<OrderData>(responseJson);
var paymentToken = responseData.token;
int orderId = responseData.order_id;
XsollaWebBrowser.OpenPurchaseUI(
paymentToken,
false);
Debug.Log("Response: " + webRequest.downloadHandler.text);
}
}
}
private void OnError(Error error)
{
Debug.LogError($"Error: {error.errorMessage}");
}
}
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
La logique de suivi de commande est intégrée dans la méthode GetXsollaPaymentToken
. Afin de traiter un achat réussi, passez une fonction qui est appelée lorsque le statut de la commande change à done
.
La méthode SDK AddOrderForTracking
s’utilise pour le suivi des commandes. Pour des informations détaillées sur le fonctionnement de cette méthode, référez-vous à Suivi du statut de la commande.
Obtenir l'état de la commande côté serveur
Le SDK vous permet de suivre l’état de la commande côté client de l’application. Cependant, nous vous recommandons d’implémenter le gestionnaire du webhook Paiement pour recevoir des informations sur la commande dans le back-end de l’application. Cela vous permet d’implémenter une validation supplémentaire des achats effectués.
Pour accéder à la liste complète des webhooks et obtenir des informations générales sur leur utilisation, consultez la documentation sur les webhooks.
Pour configurer les webhooks côté Xsolla :
- Ouvrez le projet dans le Compte éditeur.
- Dans le menu latéral, cliquez sur Project settings et accédez à la section Webhooks.
- Dans le champ Webhook server, entrez l’URL vers laquelle Xsolla enverra les webhooks.
Pour les tests, vous pouvez spécifier https://us-central1-{firebase-project-id}.cloudfunctions.net/webhookFakeResponse
, où {firebase-project-id}
est l’ID du projet Firebase (Firebase console > Project Settings > Project ID). Dans ce cas, Firebase simule le traitement réussi du webhook. Pour un projet réel, l’ajout d’une logique de validation des achats est requis.
Pour tester les webhooks, vous pouvez également choisir n’importe quel site dédié, tel que webhook.site, ou une plateforme, telle que ngrok.
- 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.
- Cliquez sur Enable webhooks.
Faute de frappe ou autre erreur dans le texte ? Sélectionnez le texte concerné et appuyez sur Ctrl+Entée.