Zum Inhalt springen

Ü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
Sprachen
Server
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/de/api/catalog/
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen

Alle Warenkorbartikel aus dem aktuellen Warenkorb löschenClient-side

Anfrage

Löscht alle Artikel im Warenkorb.

Sicherheit
AuthForCart
Pfad
project_idintegererforderlich

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

Beispiel: 44056
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/cart/clear \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Antworten

Der Warenkorb wurde erfolgreich geleert.

Artikel in den Warenkorb legenClient-side

Anfrage

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

Sicherheit
AuthForCart
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/json
itemsArray of objectserforderlich

Liste der Artikel.

Beispiel: [{"quantity":123,"sku":"com.xsolla.booster_mega_1"}]
items[].​quantitynumbererforderlich
Standard 123
items[].​skustringerforderlich
Standard "booster_mega_1"
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/cart/fill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "quantity": 123,
        "sku": "com.xsolla.booster_mega_1"
      }
    ]
  }'

Antworten

Der Warenkorb mitsamt der Artikel wurde erfolgreich zurückgegeben.

Bodyapplication/json
cart_idstring

Warenkorb-ID.

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.

Beispiel: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
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": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }

Warenkorbartikel aus aktuellem Warenkorb löschenClient-side

Anfrage

Entfernt einen Artikel aus dem Warenkorb.

Sicherheit
AuthForCart
Pfad
project_idintegererforderlich

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

Beispiel: 44056
item_skustringerforderlich

Artikel-SKU.

Beispiel: booster_mega_1
curl -i -X DELETE \
  https://store.xsolla.com/api/v2/project/44056/cart/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Antworten

Der Artikel aus dem Warenkorb wurde erfolgreich gelöscht.

Antwort
Kein Inhalt
Operationen
Operationen
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