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

Zahlung (clientseitig)

Operationen

Zahlung (serverseitig)

Operationen

Bestellung

Operationen

Kostenlose Artikel

Operationen

Verwaltung

Operationen

Verwaltung

Operationen

Webhooks

Operationen

Vorbestellungen

Operationen

Mengenangabe für das Vorbestelllimit des Artikels entfernenServer-sideAdmin

Anfrage

Entfernen Sie eine Mengenangabe für das Vorbestelllimit des Artikels.

Die entsprechende API (Pre-Order limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal vorbestellbar sind. Um die Vorbestellung selbst zu konfigurieren, wechseln Sie zum Abschnitt "Verwaltung" des gewünschten Moduls:

Aliasse für diesen Endpunkt:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
Sicherheit
basicAuth
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
quantityintegererforderlich

Zu entfernende Menge.

curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

Antworten

Das Mengenlimit wurde erfolgreich entfernt.

Antwort
Kein Inhalt

Informationen zum Artikelvorbestelllimit abrufenServer-sideAdmin

Anfrage

Rufen Sie das Vorbestelllimit des Artikels ab.

Die entsprechende API (Pre-Order limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal vorbestellbar sind. Um die Vorbestellung selbst zu konfigurieren, wechseln Sie zum Abschnitt "Verwaltung" des gewünschten Moduls:

Aliasse für diesen Endpunkt:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
Sicherheit
basicAuth
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 GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1

Antworten

Informationen zum Artikelvorbestelllimit wurden erfolgreich empfangen.

Bodyapplication/json
availableinteger
Beispiel: 431
is_pre_order_limit_enabledboolean
Beispiel: true
item_idinteger
Beispiel: 1
reservedinteger
Beispiel: 13
skustring
Beispiel: "com.xsolla.item_1"
soldinteger
Beispiel: 556
Antwort
application/json
{
  "available": 431,
  "is_pre_order_limit_enabled": true,
  "item_id": 1,
  "reserved": 13,
  "sku": "com.xsolla.item_1",
  "sold": 556
}

Artikelvorbestelllimit um Mengenangabe ergänzenServer-sideAdmin

Anfrage

Ergänzen Sie das Vorbestelllimit des Artikels um eine Mengenangabe.

Die entsprechende API (Pre-Order limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal vorbestellbar sind. Um die Vorbestellung selbst zu konfigurieren, wechseln Sie zum Abschnitt "Verwaltung" des gewünschten Moduls:

Aliasse für diesen Endpunkt:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
Sicherheit
basicAuth
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
quantityintegererforderlich

Zu ergänzende Menge.

curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

Antworten

Das Mengenlimit wurde erfolgreich ergänzt.

Antwort
Kein Inhalt

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