Zum Inhalt springen

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Catalog API bietet Endpunkte zur Verwaltung Ihres In-Game-Store-Katalogs und zur Abwicklung von Käufen. Verwenden Sie die Endpunkte zum Konfigurieren von virtuellen Gegenständen, virtuellen Währungen, Spielschlüsseln, Bundles, Warenkorb- und Zahlungsabläufen sowie Artikelattributen und zum Importieren von Artikeln aus externen Quellen.

OpenAPI-Beschreibung herunterladen
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/catalog/
https://store.xsolla.com/api/
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen

Bestellung mit allen Artikeln aus einem angegebenen Warenkorb anlegenClient-side

Anfrage

Wird für die Client-zu-Server-Integration verwendet. Legt eine Bestellung mit allen Artikeln aus dem jeweiligen Warenkorb an und generiert einen Zahlungstoken. Der angelegten Bestellung wird der Bestellstatus new zugeordnet.

Anhand der Client-IP wird das Land des Nutzers ermittelt und anschließend die entsprechende Währung und die verfügbaren Zahlungsmethoden für die Bestellung herangezogen.

Nutzen Sie den folgenden Link, um das Zahlungsportal in einem neuen Fenster aufzurufen: https://secure.xsolla.com/paystation4/?token={token}, wobei {token} der erhaltene Token ist.

Für Testzwecke steht Ihnen die folgende URL zur Verfügung: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Hinweis

Weil diese Methode auf die IP zurückgreift, um das Land des Nutzers zu ermitteln und eine Währung für die Bestellung auszuwählen, ist es wichtig, diese Methode nur clientseitig und nicht serverseitig einzusetzen. Die serverseitige Verwendung dieser Methode kann dazu führen, dass eine falsche Währung ermittelt wird, was sich wiederum auf die in der Pay Station angezeigten Zahlungsmethoden auswirkt.
Sicherheit
AuthForCart
Pfad
project_idintegererforderlich

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Beispiel: 44056
cart_idstringerforderlich

Warenkorb-ID.

Beispiel: custom_id
Bodyapplication/json
currencystring

Währung des Bestellpreises. Dreistelliger Währungscode pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.

custom_parametersobject[ 1 .. 200 ] properties

Projektspezifische Parameter.

localestring

Antwortsprache.

sandboxboolean

Legt eine Bestellung in der Testumgebung an. Die Option steht den Nutzern offen, die in der Liste der Firmennutzer aufgeführt sind.

Standard false
settingsobject

Einstellungen zum Konfigurieren des Bezahlvorgangs und des Zahlungsportals für einen Nutzer.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/de/api/catalog/v2/project/44056/payment/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Antworten

Bestellung wurde erfolgreich erstellt.

Bodyapplication/json
order_idinteger

Bestell-ID.

tokenstring

Zahlungstoken.

Antwort
application/json
{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }

Bestellung mit angegebenem Artikel anlegenClient-side

Anfrage

Wird für die Client-zu-Server-Integration verwendet. Legt eine Bestellung mit einem bestimmten Artikel an und generiert einen Zahlungstoken. Der angelegten Bestellung wird der Bestellstatus new zugeordnet.

Anhand der Client-IP wird das Land des Nutzers ermittelt und anschließend die entsprechende Währung und die verfügbaren Zahlungsmethoden für die Bestellung herangezogen.

Nutzen Sie den folgenden Link, um das Zahlungsportal in einem neuen Fenster aufzurufen: https://secure.xsolla.com/paystation4/?token={token}, wobei {token} der erhaltene Token ist.

Für Testzwecke steht Ihnen die folgende URL zur Verfügung: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Hinweis

Weil diese Methode auf die IP zurückgreift, um das Land des Nutzers zu ermitteln und eine Währung für die Bestellung auszuwählen, ist es wichtig, diese Methode nur clientseitig und nicht serverseitig einzusetzen. Die serverseitige Verwendung dieser Methode kann dazu führen, dass eine falsche Währung ermittelt wird, was sich wiederum auf die in der Pay Station angezeigten Zahlungsmethoden auswirkt.
Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.

Beispiel: 44056
item_skustringerforderlich

Artikel-SKU.

Beispiel: booster_mega_1
Bodyapplication/json
currencystring

Währung des Bestellpreises. Dreistelliger Währungscode pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.

custom_parametersobject[ 1 .. 200 ] properties

Projektspezifische Parameter.

localestring

Antwortsprache.

promo_codestring

Löst den Code einer Promocode-Aktion gegen Bezahlung ein.

quantityinteger>= 1

Artikelmenge.

Standard 1
sandboxboolean

Legt eine Bestellung in der Testumgebung an. Die Option steht den Nutzern offen, die in der Liste der Firmennutzer aufgeführt sind.

Standard false
settingsobject

Einstellungen zum Konfigurieren des Bezahlvorgangs und des Zahlungsportals für einen Nutzer.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/de/api/catalog/v2/project/44056/payment/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "promo_code": "discount_code",
    "quantity": 5,
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Antworten

Bestellung wurde erfolgreich erstellt.

Bodyapplication/json
order_idinteger

Bestell-ID.

tokenstring

Zahlungstoken.

Antwort
application/json
{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen

Katalog

Diese API ermöglicht es, jede Art von verkäuflichen oder bestimmten Artikeln zu erhalten.

Operationen
Operationen
Operationen