Zum Inhalt springen

Katalog-API (2.0.0)

Überblick

  • Version: 2.0.0
  • Server: https://store.xsolla.com/api
  • Kontakt per E-Mail
  • Kontakt-URL: https://xsolla.com/
  • Erforderliche TLS-Version: 1.2

Mit der Katalog-API können Sie aufseiten von Xsolla einen Katalog mit Ingame-Items konfigurieren und diesen Katalog den Nutzern in Ihrem Shop anzeigen.

Über die API können Sie die folgenden Katalogentitäten verwalten:

  • Virtuelle Gegenstände – Ingame-Items wie etwa Waffen, Skins, Booster.
  • Virtuelle Währung – Virtuelles Geld für den Kauf von virtuellen Gütern.
  • Virtuelle Währungspakete – vordefinierte Pakete voller virtueller Währung.
  • Bundles – eine Kombination aus virtuellen Gegenständen, Währung oder Spielschlüsseln. Bundles werden als eine einzelne SKU verkauft.
  • Spielschlüssel – Schlüssel für Spiele oder DLCs, die über Plattformen wie Steam oder andere DRM-Anbieter vertrieben werden.
  • Gruppen – logische Gruppierungen, um Artikel im Katalog zu organisieren und zu sortieren.

API-Aufrufe

Die API ist in die folgenden Gruppen unterteilt:

  • Admin – Aufrufe zum Erstellen, Aktualisieren, Löschen und Konfigurieren von Katalogartikeln und ‑gruppen. Die Authentifizierung erfolgt über die Basisauthentifizierung und Ihre Händler- oder Projekt-Anmeldedaten. Diese Aufrufe sind nicht für den Storefront bestimmt.
  • Catalog – Aufrufe zum Abrufen von Artikeln und zum Erstellen benutzerdefinierter Storefronts für Endnutzer. Konzipiert für den Einsatz unter hoher Auslastung. Unterstützt die optionale Nutzer-JWT-Autorisierung und kann personalisierte Daten (z. B. benutzerspezifische Limits und aktive Werbeaktionen) zurückgeben.
OpenAPI-Beschreibung herunterladen
index.json
index.yaml
Sprachen
Server
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/de/api/catalog/

Verwaltung

Operationen

Katalog

Operationen

Virtuelle Bezahlung

Operationen

Katalog

Operationen

Berechtigung

Operationen

Verwaltung

Operationen

Verwaltung

Operationen

Katalog

Operationen

Warenkorb (clientseitig)

Operationen

Warenkorb (serverseitig)

Operationen

Artikel in den Warenkorb legenServer-side

Anfrage

Legt Artikel in den aktuellen Warenkorb. Wenn der Warenkorb bereits einen Artikel mit derselben SKU enthält, wird der vorhandene Artikel durch den übergebenen Wert ersetzt.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Abfrage
localestring

Antwortsprache. Sprachcode bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1.

Standard "en"
Header
x-user-forstring

Die Benutzerkennung kann mithilfe des Xsolla-Login-Benutzer-JWT oder des Bezahlstation-Zugriffstokens übermittelt werden.

Beispiel: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Sie können Ihre eigene Benutzer-ID verwenden, wenn Sie einen Warenkorb mit Spielen verkaufen.

Beispiel: UNIQUE_ID
Bodyapplication/json
countrystring= 2 characters

Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern finden Sie in der Dokumentation.
Beispiel: country=US

Beispiel: "US"
currencystring= 3 characters

Die im Warenkorb angezeigte Währung des Artikelpreises. Dreistelliger Code pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.

Beispiel: "USD"
itemsArray of objectsnon-emptyerforderlich
items[].​quantitynumber>= 1erforderlich

Artikelmenge.

Beispiel: 2
items[].​skustringnon-emptyerforderlich

Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

Beispiel: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/admin/project/44056/cart/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup02"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Antworten

Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.

Bodyapplication/json
cart_idstring

Warenkorb-ID. Übermitteln Sie die ID, um die Kaufseite oder Zahlungs-API-Endpunkte abzufragen.

Beispiel: "cart_id"
is_freeboolean(value-cart_is_free)

Ist true eingestellt, ist der Warenkorb kostenlos.

Standard false
Beispiel: false
itemsArray of objects
priceobject or null

Warenkorbpreis.

promotionsArray of objects(Catalog_cart_promotions)

Auf den gesamten Warenkorb angewandte Werbeaktionen. Das Array wird in den folgenden Fällen zurückgegeben:

  • Eine Werbeaktion wirkt sich auf den Warenkorb-Gesamtbetrag aus, z. B. ein Promocode mit der Einstellung Rabatt auf den Kauf.

  • Im Rahmen einer Werbeaktion werden Bonusartikel in den Warenkorb gelegt.

Werden keine Werbeaktionen auf Bestellebene angewandt, wird ein leeres Array zurückgegeben.

warningsArray of objects
Antwort
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … },
    { … },
    { … }
  ],
  "price": {
    "amount": "15.97",
    "amount_without_discount": "22.96",
    "currency": "USD"
  },
  "promotions": [
    { … }
  ],
  "warnings": [
    { … }
  ]
}

Warenkorb anhand der Warenkorb-ID mit Artikeln zusammenstellenServer-side

Anfrage

Legt Artikel nach Warenkorb-ID in den Warenkorb. Wenn der Warenkorb bereits einen Artikel mit derselben SKU enthält, wird der vorhandene Artikel durch den übergebenen Wert ersetzt.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
cart_idstringerforderlich

Warenkorb-ID.

Beispiel: custom_id
Abfrage
localestring

Antwortsprache. Sprachcode bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1.

Standard "en"
Header
x-user-forstring

Die Benutzerkennung kann mithilfe des Xsolla-Login-Benutzer-JWT oder des Bezahlstation-Zugriffstokens übermittelt werden.

Beispiel: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Sie können Ihre eigene Benutzer-ID verwenden, wenn Sie einen Warenkorb mit Spielen verkaufen.

Beispiel: UNIQUE_ID
Bodyapplication/json
countrystring= 2 characters

Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern finden Sie in der Dokumentation.
Beispiel: country=US

Beispiel: "US"
currencystring= 3 characters

Die im Warenkorb angezeigte Währung des Artikelpreises. Dreistelliger Code pro ISO 4217. Detaillierte Informationen zu Von Xsolla unterstützte Währungen.

Beispiel: "USD"
itemsArray of objectsnon-emptyerforderlich
items[].​quantitynumber>= 1erforderlich

Artikelmenge.

Beispiel: 2
items[].​skustringnon-emptyerforderlich

Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

Beispiel: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/admin/project/44056/cart/custom_id/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup02"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Antworten

Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.

Bodyapplication/json
cart_idstring

Warenkorb-ID. Übermitteln Sie die ID, um die Kaufseite oder Zahlungs-API-Endpunkte abzufragen.

Beispiel: "cart_id"
is_freeboolean(value-cart_is_free)

Ist true eingestellt, ist der Warenkorb kostenlos.

Standard false
Beispiel: false
itemsArray of objects
priceobject or null

Warenkorbpreis.

promotionsArray of objects(Catalog_cart_promotions)

Auf den gesamten Warenkorb angewandte Werbeaktionen. Das Array wird in den folgenden Fällen zurückgegeben:

  • Eine Werbeaktion wirkt sich auf den Warenkorb-Gesamtbetrag aus, z. B. ein Promocode mit der Einstellung Rabatt auf den Kauf.

  • Im Rahmen einer Werbeaktion werden Bonusartikel in den Warenkorb gelegt.

Werden keine Werbeaktionen auf Bestellebene angewandt, wird ein leeres Array zurückgegeben.

warningsArray of objects
Antwort
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … },
    { … },
    { … }
  ],
  "price": {
    "amount": "15.97",
    "amount_without_discount": "22.96",
    "currency": "USD"
  },
  "promotions": [
    { … }
  ],
  "warnings": [
    { … }
  ]
}

Zahlung (clientseitig)

Operationen

Zahlung (serverseitig)

Operationen

Bestellung

Operationen

Kostenlose Artikel

Operationen

Verwaltung

Operationen

Verwaltung

Operationen

Webhooks

Operationen

Vorbestellungen

Operationen

Händler

Operationen

Katalog

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

Operationen

Gängige Regionen

Operationen

Verwaltung

Operationen