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
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen

Alle Kauflimits für den angegebenen Benutzer aktualisierenServer-sideAdmin

Anfrage

Aktualisiert alle für den angegebenen Nutzer geltenden Artikelkauflimits, damit er diese Artikel wieder kaufen kann.

Die entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt "Verwaltung" des gewünschten Artikeltypmoduls:

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/json
userobject(User-limit_user)erforderlich
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$erforderlich

Externe Benutzer-ID.

curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Antworten

Das Limit wurde erfolgreich aktualisiert.

Antwort
Kein Inhalt

Anzahl der für einen bestimmten Benutzer verfügbaren Artikel reduzierenServer-sideAdmin

Anfrage

Verringert die verbleibende Anzahl von Artikeln, die der angegebene Nutzer innerhalb des geltenden Limits noch erhalten kann.

Die entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt "Verwaltung" des gewünschten Artikeltypmoduls:

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
availableinteger(User-limit_available)>= 1erforderlich

Wie viele Artikel der Nutzer noch erhalten kann bzw. wie oft der Nutzer Werbeaktionen innerhalb des geltenden Limits noch in Anspruch nehmen darf.

userobject(User-limit_user)erforderlich
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$erforderlich

Externe Benutzer-ID.

curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Antworten

Kauflimits für einen Nutzer wurden erfolgreich empfangen.

Bodyapplication/json
per_userobject
Antwort
application/json
{ "per_user": { "available": 9, "total": 10 } }

Anzahl der für einen bestimmten Benutzer verfügbaren Artikel abrufenServer-sideAdmin

Anfrage

Ruft ab, wie viele Artikel der angegebene Nutzer innerhalb des geltenden Limits noch erhalten kann.

Die entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt "Verwaltung" des gewünschten Artikeltypmoduls:

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
Abfrage
user_external_idstringerforderlich

Externe Benutzer-ID

Beispiel: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/sku/booster_mega_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Antworten

Kauflimits für einen Nutzer wurden erfolgreich empfangen.

Bodyapplication/json
per_userobject
Antwort
application/json
{ "per_user": { "available": 9, "total": 10 } }
Operationen
Operationen
Operationen
Operationen

Katalog

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

Operationen
Operationen
Operationen