Configurer des webhooks

Les webhooks fonctionnent comme des notifications pour les événements système. Lorsqu’un événement spécifique se produit, Xsolla envoie une requête HTTP à votre application, généralement sous la forme d’une requête POST au format JSON, transmettant les données de l’événement.

Exemples d’événements :

• interaction de l’utilisateur avec le catalogue des objets ;
• paiement ou annulation d’une commande.

Liste des webhooks

Si vous souhaitez recevoir des notifications d’événements, implémentez la gestion des webhooks :

• Paiement — est envoyé lorsqu’une commande est payée, et contient les informations sur le paiement et les détails de la transaction.
• Paiement de commande réussi — est envoyé lorsqu’un webhook Paiement a été traité avec succès, et contient les informations sur les objets achetés et l’ID de la transaction.
• Remboursement — est envoyé lorsqu’une commande est annulée, et contient les informations sur le paiement annulé et les détails de la transaction.
• Annulation de commande — est envoyé lorsqu’un webhook Remboursement a été traité avec succès, et contient les informations sur les objets achetés et l’ID de la transaction annulée.

• Validation utilisateur — est envoyé à différentes étapes du processus de paiement pour s’assurer que l’utilisateur est bien enregistré dans le jeu. Contient des informations sur l’utilisateur qui achète la clé de jeu.

Si la personnalisation du catalogue des objets est implémentée côté application, implémentez le traitement de Personnalisation du catalogue côté partenaire.

Si vous utilisez un external ID (ID de transaction dans votre système) et que vous souhaitez l’associer à un ID de transaction côté Xsolla ou passer des paramètres de transaction supplémentaires, implémentez le webhook Transaction’s ID linking.

Configurer les webhooks dans le Compte éditeur

Pour activer la réception des webhooks :

1. Ouvrez le projet dans le Compte éditeur.
2. Dans le menu latéral, cliquez sur Project settings et accédez à l’onglet Webhooks.
3. Dans le champ Webhook server, spécifiez l’URL du serveur où vous souhaitez recevoir les webhooks, dans le format https://example.com. Vous pouvez également spécifier l’URL que vous trouvez dans un outil de test de webhooks.

4. Une clé secrète pour signer les webhooks du projet est générée par défaut. Si vous souhaitez générer une nouvelle clé secrète, cliquez sur l'icône d'actualisation.
5. Cliquez sur Enable webhooks.

1. Ouvrez le projet dans le Compte éditeur.
2. Dans le menu latéral, cliquez sur Project settings et accédez à l’onglet Webhooks.
3. Cliquez sur Disable webhooks.

Tester les webhooks dans le Compte éditeur

Vous pouvez tester la réception des webhooks suivants :

Si les webhooks sont configurés avec succès, un bloc de test de webhooks s’affiche sous le bloc de configuration des webhooks.

• Store
• Payments

Note

Pour les tests, vous devez créer au moins un package de clés de jeu.

Dans l’onglet Store, vous pouvez tester les webhooks suivants :

• Paiement de commande réussi (order_paid) ;
• Annulation de commande (order_canceled).

1. Dans le bloc de test des webhooks, naviguez jusqu'à l'onglet Store.
2. Dans le menu déroulant, sélectionnez Game keys. Si le package de clés de jeu sélectionné n'est pas configuré dans le Compte éditeur, l'un des boutons suivants s'affiche :
   • Connect — si le module contenant Game keys n'est pas connecté ;
   • Configure — si vous avez connecté le module précédemment, mais que vous n'avez pas terminé la configuration.

3. Entrez une valeur aléatoire dans le champ Xsolla Order ID.
4. Sélectionnez le package de clés de jeu dans la liste déroulante.
5. Spécifiez les plateformes d'édition de jeux.
6. Spécifiez un nombre arbitraire de clés de jeu dans le champ Amount.
7. Choisissez la devise dans laquelle la commande sera payée.
8. Cliquez sur Test.

Les webhooks Paiement de commande réussi et Annulation de commande avec les données spécifiées sont envoyés à l’URL fournie. Les résultats du test de chaque type de webhook sont affichés sous les boutons Test.

Note

Si un message d’erreur apparaît dans le bloc de test indiquant que le test n’a pas réussi, vérifiez les paramètres de réponse du webhook dans votre écouteur webhook. Des informations sur ces erreurs sont disponibles dans les résultats du test.

Dans l’onglet Payments, vous pouvez tester les webhooks suivants :

• Validation utilisateur (user_validation) ;
• Paiement (payment).

Pour tester :

1. Dans la section de test, accédez à l’onglet Payments.
2. Remplissez les champs nécessaires :
   • User ID — lors des tests, utilisez n’importe quelle combinaison de lettres et de chiffres ;
   • Public user ID — ID connu de l’utilisateur, par exemple, une adresse e-mail ou un pseudo. Ce champ est affiché si l’ID utilisateur public est activé dans votre projet dans la section Pay Station > Settings > Additional settings ;
   • Currency — sélectionnez une devise dans la liste déroulante ;
   • Xsolla Invoice ID — ID de transaction côté Xsolla. Lors des tests, utilisez une valeur numérique aléatoire ;
   • Amount — montant du paiement. Lors des tests, utilisez n’importe quelle valeur numérique ;
   • Invoice ID — ID de transaction côté de votre jeu. Lors des tests, n’importe quelle combinaison de lettres et de chiffres est admissible. Il n’est pas nécessaire pour un paiement réussi, mais vous pouvez le transmettre pour lier l’ID de transaction de votre côté à l’ID de transaction côté Xsolla.
3. Cliquez sur Test webhooks.

Vous recevrez des webhooks avec des données remplies à l’URL spécifiée. Les résultats de chaque webhook, pour un scénario réussi et un scénario avec une erreur, sont affichés sous le bouton Test webhooks. Si l’ID utilisateur public est activé dans votre projet, les résultats de la vérification de la recherche utilisateur seront également visibles.

Il est nécessaire de configurer le traitement des deux scénarios pour chaque webhook : un scénario réussi et un scénario avec une erreur.

Lorsque vous enregistrez l’URL dans le champ Webhook server, explorez la section Advanced settings pour accorder les autorisations de recevoir des informations détaillées via les webhooks. Pour ce faire, réglez les bascules correspondantes sur On. À côté de chaque autorisation, la liste des webhooks affectés par les paramètres s’affiche.

Écouteur webhook

L’écouteur webhook est un code de programme qui permet de recevoir des webhooks entrants à une adresse URL spécifiée, de générer une signature et d’envoyer une réponse au serveur webhook de Xsolla.

Génération d'une signature

Lorsque vous recevez un webhook, vous devez vous assurer de la sécurité de la transmission des données. Pour cela, vous devez générer une signature à partir des données du webhook et vérifier qu’elle correspond à la signature envoyée dans l’en-tête de la requête HTTP.

Pour générer une signature :

1. Concaténez le JSON du corps de la requête avec la clé secrète du projet.
2. Appliquez la fonction de hachage cryptographique SHA-1 à la chaîne obtenue lors de la première étape.

Envoi de réponses au webhook

Pour confirmer la réception du webhook, votre serveur doit renvoyer :

• Un code HTTP 200, 201 ou 204 en cas de réponse positive ;
• Un code HTTP 400 avec description du problème au cas où l’utilisateur spécifié n’a pas été trouvé ou une signature non valide a été passée.

Votre gestionnaire de webhooks peut également renvoyer un code 5xx en cas de problèmes temporaires sur votre serveur.

Si aucune réponse n’a été reçue pour les webhooks Successful payment of the order et Order cancellation ou si une réponse contenant un code 5xx a été reçue, les webhooks sont renvoyés selon le calendrier suivant :

• 2 tentatives à intervalles de 5 minutes ;
• 7 tentatives à intervalles de 15 minutes ;
• 10 tentatives à intervalles de 60 minutes.

Un maximum de 20 tentatives d’envoi de webhooks sont effectuées dans les 12 heures suivant la première tentative.

Si aucune réponse n’a été reçue pour le webhook Payment ou si une réponse contenant un code 5xx a été reçue, les webhooks sont également renvoyés à intervalles de temps croissants. Un maximum de 12 tentatives sont effectuées dans les 12 heures.

Si aucune réponse n’a été reçue pour le webhook User validation ou si une réponse contenant un code 400 ou 5xx a été reçue, le webhook User validation n’est pas renvoyé.

Dans ce cas, une erreur est affichée à l’utilisateur et les webhooks Payment et Successful payment of the order ne sont pas envoyés.