Webhooks einrichten

Webhooks sind Benachrichtigungen über Ereignisse, die im System auftreten. Wenn ein bestimmtes Ereignis eintritt, sendet Xsolla eine HTTP-Anfrage mitsamt den Ereignisdaten an Ihre Anwendung. Dabei handelt es sich in der Regel um eine POST-Anfrage im JSON-Format.

Beispielereignis:

• Nutzer interagiert mit einem Artikelkatalog
• Bestellung wird bezahlt oder storniert

Liste der Webhooks

Wenn Sie Ereignisbenachrichtigungen erhalten möchten, implementieren Sie das Webhook-Handling:

• Zahlung — wird gesendet, wenn eine Bestellung bezahlt wurde, und enthält die Zahlungsdaten sowie die Transaktionsdetails.
• Bestellung erfolgreich bezahlt — wird gesendet, wenn ein Zahlung-Webhook erfolgreich verarbeitet wurde, und enthält Informationen über die gekauften Artikel und die Transaktions-ID.
• Erstattung — wird gesendet, wenn eine Bestellung storniert wurde, und enthält die Daten der stornierten Zahlung sowie die Transaktionsdetails.
• Bestellung storniert — wird gesendet, wenn ein Erstattung-Webhook erfolgreich verarbeitet wurde, und enthält Informationen über die gekauften Artikel und die ID der stornierten Transaktion.

• Benutzervalidierung — wird während der verschiedenen Phasen des Zahlungsvorgangs gesendet, um sicherzustellen, dass der Benutzer im Spiel registriert ist. Enthält Informationen über den Käufer des Spielschlüssels.

Ist die Artikelkatalog personalisierung aufseiten Ihrer Anwendung implementiert, richten Sie die Verarbeitung der Katalogpersonalisierung aufseiten des Partners ein.

Wenn Sie eine externe ID (Transaktions-ID aus Ihrem System) verwenden und diese mit einer Transaktions-ID aufseiten von Xsolla verknüpfen oder zusätzliche Transaktionsparameter übermitteln möchten, implementieren Sie den Webhook Verknüpfung der Transaktions-ID.

Webhooks im Kundenportal einrichten

So aktivieren Sie den Empfang von Webhooks:

1. Öffnen Sie Ihr Projekt im Kundenportal.
2. Klicken Sie in der Seitenleiste auf Projekteinstellungen, und wechseln Sie zur Registerkarte Webhooks.
3. Geben Sie im Feld Webhook-Server die URL Ihres Servers an, auf dem Sie Webhooks im Format https://example.com empfangen möchten. Sie können auch eine URL aus einem Tool, mit dem sich Webhooks testen lassen, angeben.

4. Standardmäßig wird ein geheimer Schlüssel zum Signieren von Projekt-Webhooks generiert. Wenn Sie einen neuen geheimen Schlüssel generieren möchten, klicken Sie auf das Aktualisieren-Symbol.
5. Klicken Sie auf Webhooks aktivieren.

1. Öffnen Sie Ihr Projekt im Kundenportal.
2. Klicken Sie in der Seitenleiste auf Projekteinstellungen, und wechseln Sie zur Registerkarte Webhooks.
3. Klicken Sie auf Webhooks deaktivieren.

Webhooks im Kundenportal testen

Sie können den Erhalt der folgenden Webhooks testen:

Sofern die Webhooks erfolgreich eingerichtet sind, wird ein entsprechender Testblock unter dem Einrichtungsblock angezeigt.

• Store
• Payments

Hinweis

Zum Testen müssen Sie mindestens ein Spielschlüsselpaket erstellen.

Auf der Registerkarte Store können Sie die folgenden Webhooks testen:

• Erfolgreiche Bezahlung der Bestellung (order_paid)
• Stornierung der Bestellung (order_canceled)

1. Wechseln Sie im Testblock für Webhooks zur Registerkarte Online-Shop.
2. Wählen Sie im Drop-down-Menü die Option Spielschlüssel aus. Sind im Kundenportal noch keine Spielschlüsselpakete eingerichtet, wird eine der folgenden Schaltflächen angezeigt:
   • Verknüpfen, sofern das Spielschlüssel-Modul nicht verknüpft ist
   • Konfigurieren, sofern das Modul bereits verknüpft, aber die Einrichtung noch nicht abgeschlossen ist

3. Geben Sie den Wert in das Feld Xsolla-Bestell-ID ein.
4. Wählen Sie das Spielschlüsselpaket aus der Drop-down-Liste aus.
5. Legen Sie die Publishing-Plattformen fest.
6. Geben Sie im Feld Betrag einen beliebigen Wert für den Spielschlüssel an.
7. Wählen Sie die Währung, in der Bestellung bezahlt werden soll.
8. Klicken Sie auf Test.

Die Webhooks Bestellung erfolgreich bezahlt und Bestellung storniert mit den angegebenen Daten werden an die festgelegte URL gesendet. Die Testergebnisse für jeden Webhook-Typ werden unter der Schaltfläche Test angezeigt.

Hinweis

Wird im Testblock eine Fehlermeldung angezeigt, wonach der Test nicht erfolgreich war, sollten Sie die Webhook-Antworteinstellungen in Ihrem Webhook-Listener überprüfen. Informationen über diese Fehler sind in den Testergebnissen ersichtlich.

Auf der Registerkarte “Payments” können Sie die folgenden Webhooks testen:

• Benutzervalidierung (user_validation)
• Zahlung (payment)

Gehen Sie zum Testen wie folgt vor:

1. Wechseln Sie im Testblock für Webhooks zur Registerkarte Payments.
2. Füllen Sie die Pflichtfelder aus:
   • Benutzer-ID – zum Testen können Sie eine beliebige Kombination aus Buchstaben und Ziffern angeben.
   • Public-User-ID – ID, die einem Nutzer bekannt ist, z. B. E-Mail-Adresse oder Nickname. Dieses Feld wird angezeigt, sofern die Public-User-ID in Ihrem Projekt unter Pay Station > Einstellungen > Sonstige Einstellungen aktiviert ist.
   • Währung – wählen Sie ein Währung aus der Drop-down-Liste aus.
   • Xsolla-Rechnungs-ID – Transaktions-ID aufseiten von Xsolla. Zum Testen können Sie eine beliebige Ziffernfolge angeben.
   • Menge – Zahlungsbetrag. Zum Testen können Sie eine beliebige Ziffernfolge angeben.
   • Rechnungs-ID – Transaktions-ID aufseiten Ihres Spiels. Zum Testen können Sie eine beliebige Kombination aus Buchstaben und Ziffern angeben. Dieser Parameter ist nicht erforderlich, um die Zahlung erfolgreich zu verarbeiten. Allerdings können Sie die Transaktions-ID aufseiten Ihres Spiels mit der Transaktions-ID aufseiten von Xsolla verknüpfen, indem Sie den Parameter übermitteln.
3. Klicken Sie auf Webhooks testen.

Unter der angegebenen URL erhalten Sie Webhooks mit ausgefüllten Daten. Die Testergebnisse jedes Webhooks, sowohl für ein erfolgreiches Szenario als auch für ein Fehlerszenario, werden unter der Schaltfläche Webhooks testen angezeigt. Wenn in Ihrem Projekt die Public-User-ID aktiviert ist, werden ebenso die Ergebnisse einer Benutzerprüfung angezeigt.

Für jeden Webhook müssen Sie die Verarbeitung beider Szenarien, also erfolgreich und fehlerbehaftet, konfigurieren.

Wenn Sie eine URL im Feld Webhook-Server speichern, erscheint der Abschnitt Erweiterte Einstellungen, in dem Sie die Berechtigungen, detaillierte Informationen in Webhooks empfangen zu dürfen, erteilen können. Stellen Sie dazu die entsprechenden Schalter auf Ein. In der Zeile der jeweiligen Berechtigung wird eine Liste der Webhooks angezeigt, die von den Einstellungen betroffen sind.

Webhook-Listener

Ein Webhook-Listener ist ein Programmcode, der es ermöglicht, eingehende Webhooks unter einer bestimmten URL-Adresse zu empfangen, eine Signatur zu generieren und dem Xsolla-Webhook-Server zu antworten.

Signatur generieren

Beim Empfang eines Webhooks ist die Sicherheit der Datenübermittlung zu gewährleisten. Dazu muss aus den Webhook-Daten eine Signatur generiert und danach überprüft werden, ob sie mit der im HTTP-Anfrage-Header gesendeten Signatur übereinstimmt.

So generieren Sie eine Signatur:

1. Verketten Sie das JSON aus dem Anfragerumpf mit dem geheimen Schlüssel des Projekts.
2. Wenden Sie die kryptografische Hash-Algorithmus SHA-1 auf den im ersten Schritt erhaltenen String an.

Dem Webhook antworten

Um den Empfang eines Webhooks zu bestätigen, muss Ihr Server wie folgt antworten:

• HTTP-Statuscode 200, 201 oder 204 ohne Nachrichtenrumpf im Falle einer positiven Antwort.
• HTTP-Statuscode 400 samt Problembeschreibung, sofern der angegebene Benutzer nicht gefunden oder eine ungültige Signatur übermittelt wurde.

Ihr Webhook-Handler kann ebenso mit einem HTTP-Statuscode 5xx antworten, falls Ihr Server vorübergehend Probleme hat.

Erfolgt keine Antwort auf die Webhooks Bestellung erfolgreich bezahlt und Bestellung storniert oder wurde eine Antwort mit dem Code 5xx empfangen, werden die Webhooks nach folgendem Zeitplan erneut gesendet:

• Zwei Versuche im Abstand von 5 Minuten
• Sieben Versuche im Abstand von jeweils 15 Minuten
• Zehn Versuche im Abstand von jeweils 60 Minuten

Innerhalb von 12 Stunden nach dem ersten Versuch werden maximal 20 Versuche unternommen, Webhooks zu senden.

Erfolgt keine Antwort auf den Webhook Zahlung oder wurde eine Antwort mit dem Code 5xx empfangen, werden die Webhooks in längeren Zeitabständen erneut gesendet. Innerhalb von 12 Stunden werden maximal 12 Versuche unternommen.

Erfolgt keine Antwort auf den Webhook Benutzervalidierung oder wurde eine Antwort mit dem Code 400 oder 5xx empfangen, wird der Webhook Benutzervalidierung nicht erneut gesendet.

In diesem Fall wird dem Benutzer ein Fehler angezeigt und die Webhooks Zahlung und Bestellung erfolgreich bezahlt werden nicht gesendet.