Physische Waren

Physische Waren ist eine Lösung, die auf dem Modul virtuelle Gegenstände basiert und die es Spieleentwicklern ermöglicht, spieleigene Merchandise-Artikel zu verkaufen. Basierend auf der Xsolla-API, wird ein spieleigener Store erstellt. Xsolla stellt ein Zahlungsportal bereit und organisiert die Auslieferung zum Endkunden.

Integrationsleitfaden

Gehen Sie folgendermaßen vor, um das Modul zu integrieren:

  1. Registrieren Sie sich im Xsolla-Kundenportal.
  2. Legen Sie ein Projekt an.
  3. Richten Sie das Modul ein.
  4. Implementieren Sie die Verwaltung physischer Waren.
  5. Aktivieren Sie den Lieferservice.
  6. Fordern Sie einen Token an.
  7. Richten Sie ein, wie das Aufrufen des Zahlungsportals von statten gehen soll.
  8. Richten Sie Webhook-Handling ein.
  9. Testen Sie den Zahlungsvorgang aus.
  10. Veröffentlichen Sie das Modul und unterschreiben Sie die Vereinbarung.

Folgende Parameter sind für die Integration erforderlich:

  • Händler-ID — wird in der URL des Kundenportals angezeigt: https://publisher.xsolla.com/{merchant_id}/.
  • API-Schlüssel — wird unter Kundenportal > Einstellungen > Unternehmen generiert.
  • Projekt-ID — wird in der URL des Kundenportals beim Betrachten der Projekteinstellungen angezeigt: https://publisher.xsolla.com/{merchant_id}/projects/{project_id}/.
  • Geheimer Schlüssel des Projekts — wird in den Projekteinstellungen generiert.

Ein Projekt anlegen

  1. Gehen Sie zu Projekte und klicken Sie auf Neues Projekt anlegen.
  2. Gehen Sie in den Projekteinstellungen folgendermaßen vor:
    • Legen Sie die Webhook-URL fest.
    • Generieren Sie einen geheimen Schlüssel, um Webhooks für das Projekt signieren zu können.
    • Schalten Sie Virtuelle Gegenstände ein.
    • Gehen Sie zu Benutzer und stellen Sie Benutzerdaten in Xsolla abspeichern auf Ein.

Modul einrichten

  1. Gehen Sie zu den Moduleinstellungen für Virtuelle Gegenstände und klicken Sie auf Gruppe von Gegenständen anlegen. Konfigurieren Sie die Gruppe:
    • Stelle im Katalog (Stammverzeichnis voreingestellt).
    • Code.
    • Name und Beschreibung.
    • Falls die Gruppe im Store angezeigt werden soll, überprüfen Sie Im Store anzeigen.
  2. Klicken Sie auf Anlegen.
  3. Klicken Sie auf Liste der Gegenstände, um zu den Grundeinstellungen des Moduls zurückzukehren und, je nach Bedarf, weitere Gruppen für Ihren Katalog anzulegen.
  4. Klicken Sie auf Gegenstand anlegen und definieren Sie dessen Parameter:
    • Anzahl der Gruppen, denen der Gegengenstand angehört (eine oder mehrere). Falls keine Gruppe ausgewählt ist, wird der Gegenstand im Store nicht angezeigt.
    • SKU — eine eindeutige Kennung.
    • Name und kurze Beschreibung.
    • Preis in echter Währung.
    • Bild.
  5. Setzen Sie die Einstellung für Physische Waren auf Ein.
  6. Klicken Sie auf Anlegen.
  7. Klicken Sie auf Liste der Gegenstände, um zu den Grundeinstellungen des Moduls zurückzukehren und, je nach Bedarf, weitere Gegenstände anzulegen.

Physische Waren verwalten

Gehen Sie folgendermaßen vor, um physische Waren zu verwalten:

  1. Implementieren Sie das Abrufen der Produktliste für den Marktplatz mittels API-Methode "Virtuelle Gegenstände im Storefront auflisten".
  2. Implementieren Sie die Inventarkontrolle mittels API-Methode "Inventarstatus anfordern".
  3. Beziehen Sie den Token, um das Zahlungsportal aufzurufen.

Lieferservice aktivieren

Über die Liste der verfügbaren Lieferservices wird für jeden Partner einzeln beratschlagt. Für weitere Informationen senden Sie bitte eine Liste Ihrer Fulfillment-Plattformen und deren IDs an Ihren Account Manager.

Token für das Zahlungsportal beziehen

Sie sollten einen Zugriffstoken beziehen, um das Zahlungsportal in Ihr Spiel zu integrieren. Ein Zugriffstoken ist ein String, mit dem die Spiele-, Benutzer- und Kaufparameter identifiziert werden. Die Xsolla-API nutzt HTTP-Basic-Authentication. Geben Sie Ihre Händler-ID als Basic-Auth-Nutzername und den API-Schlüssel als Passwort an.

Legen Sie für den Parameter "mode" den Wert "sandbox" fest, um den Zahlungsvorgang auszutesten.

Token-Endpunkt anfordern:

https://api.xsolla.com/merchant/merchants/{merchant_id}/token

Sie können die Parameter für die Store-Benutzeroberfläche in einer HTTP-POST-Anfrage verwenden. Anfrage- und Antwort-Nutzdaten sind als JSON formatiert.

Beispiel für eine Anfrage

Nachstehend finden Sie ein Beispiel für das Abrufen des Tokens in PHP mit Hilfe des Xsolla-PHP-SDK. Falls Sie eine andere Programmiersprache verwenden, schauen Sie sich das CURL-Beispiel an, indem Sie auf die Registerkarte "CURL" klicken.

PHP
CURL
<?php

use Xsolla\SDK\API\XsollaClient;
use Xsolla\SDK\API\PaymentUI\TokenRequest;

$tokenRequest = new TokenRequest($projectId, $userId);
$tokenRequest->setUserEmail('email@example.com')
     ->setExternalPaymentId('12345')
     ->setSandboxMode(true)
     ->setUserName('USER_NAME')
     ->setCustomParameters(array('key1' => 'value1', 'key2' => 'value2'));

$xsollaClient = XsollaClient::factory(array(
     'merchant_id' => MERCHANT_ID,
     'api_key' => API_KEY
));
$token = $xsollaClient->createPaymentUITokenFromRequest($tokenRequest);
     curl -v https://api.xsolla.com/merchant/merchants/{merchant_id}/token \
     -X POST \
     -u your_merchant_id:merchant_api_key \
     -H 'Content-Type:application/json' \
     -H 'Accept: application/json' \
     -d '
     {
         "user": {
             "id": {
                 "value": "1234567"
             },
             "email": {
                 "value": "email@example.com"
             }
         },
         "settings": {
             "project_id": 14004,
             "mode": "sandbox"
         }
     }'

Die vollständige Liste der Parameter finden Sie in der API-Referenz.

Zahlungsportal aufrufen

Es gibt drei Möglichkeiten, das Zahlungsportal aufzurufen:

  • Verwenden Sie das eingebettete Pay-Station-Script.
  • Neues Fenster.
  • Iframe.

Nutzen Sie folgende URL, um das Zahlungsportal im Sandbox-Modus aufzurufen: https://sandbox-secure.xsolla.com/.

Pay Station einbetten

Das Script Pay-Station einbetten bestimmt den Gerätetyp und ruft das Zahlungsportal in einer Lightbox (bei Desktop-Bildschirmen) oder in einem neuen Fenster (bei mobilen Endgeräten) auf. Wir empfehlen Ihnen, asynchrones Laden von Scripten zu verwenden.

Beispiel für asynchrones Laden eines Scripts:

  <script>
      var options = {
          access_token: 'ACCESS_TOKEN', //TODO use access token, received on previous step
          sandbox: true //TODO please do not forget to remove this setting when going live
      };
      var s = document.createElement('script');
      s.type = "text/javascript";
      s.async = true;
      s.src = "https://static.xsolla.com/embed/paystation/1.0.7/widget.min.js";
      s.addEventListener('load', function (e) {
          XPayStationWidget.init(options);
      }, false);
      var head = document.getElementsByTagName('head')[0];
      head.appendChild(s);
  </script>

<button data-xpaystation-widget-open>Buy Credits</button>

Die vollständige Liste der Parameter finden Sie in der API-Referenz.

Neues Fenster

Nutzen Sie bitte folgenden Link, um das Zahlungsportal in einem neuen Fenster aufzurufen: https://secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN; wobei ACCESS_TOKEN der Token ist, der im vorherigen Schritt bezogen wurde.

Iframe

Um das Zahlungsportal in einem iframe aufzurufen, müssen Sie Ihrerseits folgenden Mechanismus implementieren:

  • Definieren Sie den Gerätetyp (Desktop oder mobiles Endgerät) und senden Sie ihn innerhalb des Tokens mittels settings.ui.version Parameter;
  • Empfang von Ereignissen aus dem Zahlungsportal via postMessage.

Nutzen Sie bitte folgenden Link, um das Zahlungsportal in einem neuen Fenster aufzurufen: https://secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN; wobei ACCESS_TOKEN der Token ist, der im vorherigen Schritt bezogen wurde.

Webhooks einrichten

Xsolla sendet die folgenden Webhooks an Ihr Projekt:

  • Benutzervalidierung
  • Zahlung
  • Rückerstattung

Um zu bestätigen, dass Sie die Webhook-Benachrichtigungen ohne Probleme erhalten haben, sollte Ihr Server mit dem HTTP-Statuscode 204 ohne Nachrichtenrumpf antworten. Die ausführliche Beschreibung des Webhook-Mechanismus samt Beispielen finden Sie in der API-Referenz.

Eine Signatur erstellen

Gehen Sie folgendermaßen vor, um eine Signatur zu erstellen:

  1. Verknüpfen Sie die Daten aus der Anfrage des Xsolla-Servers mit dem geheimen Schlüssel des Projekts (wird in den Projekteinstellungen generiert).
  2. Wenden Sie den SHA1-Hash-Algorithmus bei den Strings an.
  3. Versenden Sie die Signatur im Signatur-Header.

Achten Sie bei der Handhabung von Webhooks darauf, dass die Signatur, welche Sie empfangen, mit jener übereinstimmt, die Sie im Signatur-Header festgelegt haben.

Benutzervalidierung

Der Xsolla-Server sendet eine Anfrage an die Webhook-URL des Projekts, um zu verifizieren, ob ein Benutzer im Spiel vorhanden ist.

Beispiel für eine Anfrage

PHP
CURL
$request = array(
     'notification_type' => 'user_validation',
     'user' => array(
         'ip' => '127.0.0.1',
         'phone' => '18777976552',
         'email'=> 'email@example.com',
         'id'=> '1234567',
         'country' => 'US'
     )
)
curl -v https://example.com/ \
-X POST \
-H 'Content-Type:application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Signature 13342703ccaca5064ad33ba451d800c5e823db8f' \
-d '
{
     "notification_type": "user_validation",
     "user": {
         "ip": "127.0.0.1",
         "phone": "18777976552",
         "email": "email@example.com",
         "id": "1234567",
         "country": "US"
     }
}'

Die vollständige Liste der Parameter finden Sie in der API-Referenz.

Zahlung

Immer wenn ein Benutzer eine Zahlung tätigt, sendet der Xsolla-Server einen Webhook inklusive Zahlungsdaten.

Beispiel für eine Anfrage

PHP
CURL
$request = array(
     'notification_type' => 'payment',
     'purchase' => array(
         'virtual_items' => array(
             'items' => array(
                 0 => array(
                     'sku' => 'test_item1',
                     'amount' => 1,
                     ),
                 1 => array(
                     'sku' => 'test_item2',
                     'amount' => 1,
                     ),
                 2 => array(
                     'sku' => 'test_item3',
                     'amount' => 1,
                     ),
             )
         ),
         'total' => array(
             'currency' => 'USD',
             'amount' => 9.99
         )
     ),
     'user' => array(
         'ip' => '127.0.0.1',
         'phone' => '18777976552',
         'email' => 'email@example.com',
         'id' => '1234567',
         'country' => 'US'
     ),
     'transaction' => array(
         'id' => 87654321,
         'payment_date' => '2014-09-23T19:25:25+04:00',
         'payment_method' => 1380,
         'dry_run' => 1
     ),
     'payment_details' => array(
         'payment' => array(
             'currency' => 'USD',
             'amount' => 9.99
         ),
         'vat' => array(
             'currency' => 'USD',
             'amount' => 0
         ),
         'payout_currency_rate' => 1,
         'payout' => array(
             'currency' => 'USD',
             'amount' => 9.49
         ),
         'xsolla_fee' => array(
             'currency' => 'USD',
             'amount' => 0.19
         ),
         'payment_method_fee' => array(
             'currency' => 'USD',
             'amount' => 0.31
         )
     )
)
curl -v https://example.com/ \
-X POST \
-H 'Content-Type:application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Signature 13342703ccaca5064ad33ba451d800c5e823db8f' \
-d '
{
     "notification_type": "payment",
     "purchase": {
         "virtual_items": {
             "items": [
                 {
                     "sku": "test_item1",
                     "amount": 1
                 },
                 {
                     "sku": "test_item2",
                     "amount": 1
                 },
                 {
                     "sku": "test_item3",
                     "amount": 2
                 },
             ]
         },
         "total": {
             "currency": "USD",
             "amount": 9.99
         }
     },
     "user": {
         "ip": "127.0.0.1",
         "phone": "18777976552",
         "email": "email@example.com",
         "id": "1234567",
         "country": "US"
     },
     "transaction": {
         "id": 87654321,
         "payment_date": "2014-09-23T19:25:25+04:00",
         "payment_method": 1380,
         "dry_run": 1
     },
     "payment_details": {
         "payment": {
             "currency": "USD",
             "amount": 9.99
         },
         "vat": {
             "currency": "USD",
             "amount": 0
         },
         "payout_currency_rate": 1,
         "payout": {
             "currency": "USD",
             "amount": 9.49
         },
         "xsolla_fee": {
             "currency": "USD",
             "amount": 0.19
         },
         "payment_method_fee": {
             "currency": "USD",
             "amount": 0.31
         }
     }
}'

Die vollständige Liste der Parameter finden Sie in der API-Referenz.

Rückerstattung

Falls der Benutzer die Zahlung storniert, sendet der Xsolla-Server eine Webhook-Benachrichtigung mit Zahlungsdaten.

Beispiel für eine Anfrage

PHP
CURL
$request = array(
     'notification_type' => 'refund',
     'purchase' => array(
         'virtual_currency' => array(
             'name' => 'Coins',
             'quantity' => 100,
             'currency' => 'USD',
             'amount' => 9.99
         ),
         'total' => array(
             'currency' => 'USD',
             'amount' => 9.99
         )
     ),
     'user' => array(
         'ip' => '127.0.0.1',
         'phone' => '18777976552',
         'email' => 'email@example.com',
         'id' => '1234567',
         'country' => 'US'
     ),
     'transaction' => array(
         'id' => 87654321,
         'payment_date' => '2014-09-23T19:25:25+04:00',
         'payment_method' => 1380,
         'dry_run' => 1
     ),
     'refund_details' => (
             'code' => 1,
             'reason' => 'Fraud'
     ),
     'payment_details' => array(
         'payment' => array(
             'currency' => 'USD',
             'amount' => 9.99
         ),
         'vat' => array(
             'currency' => 'USD',
             'amount' => 0
         ),
         'payout_currency_rate' => 1,
         'payout' => array(
             'currency' => 'USD',
             'amount' => 9.49
         ),
         'xsolla_fee' => array(
             'currency' => 'USD',
             'amount' => 0.19
         ),
         'payment_method_fee' => array(
             'currency' => 'USD',
             'amount' => 0.31
         )
     )
);
curl -v https://example.com/ \
-X POST \
-H 'Content-Type:application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Signature 13342703ccaca5064ad33ba451d800c5e823db8f' \
-d '
{
     "notification_type":"refund",
     "purchase":{
         "virtual_currency":{
             "name": "Coins",
             "quantity":10,
             "currency":"USD",
             "amount":100
         },
         "subscription":{
             "plan_id": "b5dac9c8",
             "subscription_id": "10",
             "date_create": "2014-09-22T19:25:25+04:00",
             "currency": "USD",
             "amount": 9.99
         },
         "checkout":{
             "currency":"USD",
             "amount":50
         },
         "virtual_items":{
             "items":[
                 {
                     "sku": "test_item1",
                     "amount":1
                 }
             ],
             "currency":"USD",
             "amount":50
         },
         "total":{
             "currency":"USD",
             "amount":200
         }
     },
     "user": {
         "ip": "127.0.0.1",
         "phone": "18777976552",
         "email": "email@example.com",
         "id": "1234567",
         "name": "Xsolla User",
         "country": "US"
     },
     "transaction":{
         "id":1,
         "external_id":1,
         "dry_run":1,
         "agreement":1
     },
     "refund_details":{
         "code":1,
         "reason":"Fraud"
     },
     "payment_details":{
         "xsolla_fee":{
             "currency":"USD",
             "amount":"10"
         },
         "payout":{
             "currency":"USD",
             "amount":"200"
         },
         "payment_method_fee":{
             "currency":"USD",
             "amount":"20"
         },
         "payment":{
             "currency":"USD",
            "amount":"230"
         }
     }
}'

Die vollständige Liste der Parameter finden Sie in der API-Referenz.

Webhooks testen

Gehen Sie folgendermaßen vor, um einen Webhook-Handler zu testen:

  1. Öffnen Sie die Moduleinstellungen im Kundenportal.
  2. Gehen Sie zur Registerkarte Testen.
  3. Geben Sie die Testdaten ein und klicken Sie auf Test. Der Xsolla-Server wird alle möglichen Webhooks senden.
  4. Im Falle einer gültigen Antwort wird der Test grün und im Falle eines Fehlers rot gekennzeichnet.

Zahlungsvorgang austesten

Xsolla-Sandbox ist eine eigenständige Umgebung, welche alle Funktionen der Live-Umgebung, mit Ausnahme echter Zahlungen, unterstützt. Sie können auf den Sandbox-Modus zugreifen, indem Sie "mode = "sandbox" beim Abrufen des Tokens versenden.

Gehen Sie folgendermaßen vor, um eine Kartenzahlung zu testen:

  1. Rufen Sie das Zahlungsportal im Sandbox-Modus auf.
  2. Klicken Sie auf Kredit-/Debitkarten.
  3. Geben Sie die Bankkartendaten und alle Werte in die verbleibenden Felder ein. Sie können auch falsche Angaben (Kartennummer, Ablaufdatum oder CVV) machen, um einen Fehler zu generieren.

List of bank cards to be used for testing

Wichtig: Sandbox-Kartenzahlungen können lediglich in USD, EUR, RUB, GBP, SGD, HKD oder THB getätigt werden.

Veröffentlichung des Moduls

Um das Modul nach dessen erfolgreichem Test zu veröffentlichen, öffnen Sie dessen Einstellungen im Kundenportal, gehen Sie zur Registerkarte Veröffentlichen und klicken Sie auf Ein.

Wichtig: Bevor Sie echte Zahlungen annehmen können, müssen Sie:

  1. "mode" = "sandbox" entfernen.
  2. Unterzeichnen Sie die Vereinbarung.