Si vous n’avez pas de serveur ou si vous implémentez la logique de traitement des achats côté client, vous pouvez utiliser les moyens suivants :

1. WebSocket API.
2. Short-polling.

Obtenir l'état d'une commande côté client à l'aide de l'API WebSocket

La solution utilise WebSockets pour obtenir les statuts des commandes sans récupérer d’informations détaillées sur celles-ci. Cette méthode est préférable, car elle établit une seule connexion entre le client (par exemple, votre site web ou votre application mobile) et le serveur Xsolla, évitant ainsi une charge supplémentaire pour le client ou le serveur.

Effectuez les étapes suivantes:

1. Pour permettre au serveur Xsolla WebSocket et à votre client d’identifier les messages d’état des commandes, créez une connexion :

const client = new Centrifuge(
connectionURL,
{
data: {
  user_external_id: user_external_id,
  auth: auth,
  project_id: project_id
}
}
)
connectionURL - wss://ws-store.xsolla.com/connection/websocket
auth - user JWT token

2. Pour recevoir de nouveaux messages sur les statuts des commandes, abonnez-vous aux événements à l'aide de la fonction client.on :

client.on('publication', (ctx) => {
   //handle the status
});

3. Déclenchez l'établissement effectif de la connexion :

client.connect()

4. Pour recevoir l'historique des changements de statuts des commandes, connectez la méthode API d'historique.

client.on('subscribed', function (ctx) {
   client.history(ctx.channel, { limit: -1, since: { offset: 0 }, reverse: false }).then(function (resp) {
resp.publications.forEach((ctx) => {
   /handle the status
});

   }, function (err) {
       //handle the status
   });
});

Exemple de corps de message:

{
order_id: 59614241,
status: 'new'
}

Les statuts de commande suivants sont possibles :

• New — la commande a été créée, mais n’est pas encore payée ;
• Paid — la commande est payée ;
• Done — la commande a été livrée (tous les reçus ont été envoyés, les livraisons ont été effectuées du côté de Xsolla, des plateformes externes, etc.) ;
• Canceled — la commande a été annulée et le paiement a été remboursé à l’utilisateur.

Recommandations d’utilisation de websocket :

• Le temps d’attente maximum pour une réponse via websocket est de 5 minutes.
• La connexion doit être établie lors de l’ouverture de l’interface de paiement.
• La connexion doit être interrompue après réception du statut final de la commande, soit Canceled ou Done.
• En cas d’expiration de la durée de vie de la websocket ou de problèmes de connexion, utilisez le short-polling.

  Short-polling

  Pour obtenir des informations détaillées sur les biens de la commande après le passage au statut approprié, appelez l’API Lire une commande.

  Note

  Une interrogation périodique du statut de la commande est utilisée : une simple requête HTTP qui reçoit le statut de la commande et des informations sur celle-ci. Le délai recommandé entre les requêtes est de 3 secondes.

La méthode XsollaCatalog.Purchase encapsule plusieurs méthodes de suivi de l’état de la commande. Le mécanisme de suivi est détaillé dans la documentation du SDK Unity destiné aux entreprises.

Vous pouvez également implémenter le traitement de l’état et du contenu de la commande, passés à la fonction de rappel onSuccess de la méthode d’achat.

Pour suivre l’état de la commande lorsque vous utilisez le SDK, vous pouvez :

• vous abonner aux changements d’état de la commande ;
• demander l’état de la commande.

S'abonner aux changements d'état des commandes

Pour vous abonner aux changements d’état des commandes, utilisez la méthode SDK getOrderStatus de la bibliothèque Store et passez-lui les paramètres suivants :

• listener — objet écouteur de type OrderStatusListener ;
• orderId — ID de la commande reçu en tant que paramètre lors de l’achat via le panier, de l’achat en un clic ou de l’achat contre de la monnaie virtuelle.

Documentation de référence du SDK

En savoir plus sur les méthodes SDK et leurs paramètres.

Exemple d’appel à la méthode XStore.getOrderStatus :

XStore.getOrderStatus(object : OrderStatusListener() {

               override fun  onStatusUpdate(status: OrderResponse.Status) {

                   if(status == OrderResponse.Status.DONE) {

                       Log.d("MainActivity", "Success")

                   }

               }

               override fun  onFailure() {

                   Log.d("MainActivity", "Failure")

               }

           }, orderId)

Nous recommandons d’appeler la méthode XStore.getOrderStatus lors de l’ouverture de l’interface de paiement.

Les méthodes d’achat encapsulent plusieurs méthodes de suivi de l’état de la commande. Le suivi est effectué selon l’algorithme suivant :

1. Une connexion WebSocket est établie.
2. Si la connexion WebSocket est établie avec succès et que le statut de la commande passe à done ou à cancel, le suivi s'arrête. Si la connexion WebSocket échoue ou si la réponse contient des données incorrectes, l'état de la commande est suivi à l'aide de short-polling.
3. Le suivi de l'état de la commande se poursuit à l'aide de short-polling. Une simple requête HTTP d'état de commande est envoyée toutes les 3 secondes. Le suivi s'arrête si le statut de la commande passe à done ou à cancel.

Demander l'état de la commande

Pour demander le statut actuel du paiement, appelez la méthode getOrder de la bibliothèque Store ; passez les paramètres suivants :

• orderId — ID de la commande, obtenu lors de l’achat de l’objet.

• callback — fonction de rappel permettant de récupérer avec succès les informations sur la commande. Lors de l’implémentation d’une fonction de rappel, utilisez l’interface GetStatusCallback et implémentez les méthodes onSuccess et onError.

• callback — fonction de rappel permettant de récupérer avec succès les informations sur la commande. Lors de l’implémentation d’une fonction de rappel, utilisez l’interface GetStatusCallback et implémentez les méthodes onSuccess et onError.

Exemple :

XPayments.getStatus(<token>, <isSandbox>, object : GetStatusCallback {
            override fun onSuccess(data: InvoicesDataResponse?) {
                Log.d(TAG, "onSuccess is fired. Result data = $data")
            }

           override fun onError(throwable: Throwable?, errorMessage: String?) {
                Log.d(TAG, "onError is fired. ErrorMessage = $errorMessage")
            }

})

Pour suivre l’état de la commande, utilisez la méthode SDK CheckPendingOrder ; passez les paramètres suivants :

• AccessToken — jeton de paiement, obtenu lors de l’achat de l’objet.
• OrderId — ID de la commande, obtenu lors de l’achat de l’objet.
• SuccessCallback — fonction de rappel en cas de paiement réussi.
• ErrorCallback — fonction de rappel en cas d’erreur de requête.
• bIsUserInvolvedToPayment — détermine l’implication de l’utilisateur dans le processus de paiement. Passez true pour l’achat en monnaie réelle, et false pour l’achat d’objets gratuits et l’achat en monnaie virtuelle.

Le mécanisme de suivi est détaillé dans la documentation du SDK Unreal Engine destiné aux entreprises.

Pour demander le statut actuel du paiement, appelez la méthode SDK CheckOrder ; passez les paramètres suivants :

• AccessToken — jeton de paiement, obtenu lors de l’achat de l’objet.
• OrderId — ID de la commande, obtenu lors de l’achat de l’objet.
• SuccessCallback — fonction de rappel en cas de vérification réussie de la commande. La réponse contient le statut de la commande.
• ErrorCallback — fonction de rappel en cas d’erreur de requête.