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

Codes anhand der ID löschenServer-sideAdmin

Anfrage

Löscht alle Codes anhand der Spielschlüssel-ID.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
item_idstringerforderlich

Artikel-ID.

Beispiel: 656
Abfrage
user_emailstringerforderlich

E-Mail-Adresse des Nutzers.

Beispiel: user_email=email@email.com
reasonstringerforderlich

Grund für den Empfang von Codes.

Beispiel: reason=Very important
region_idinteger

Regions-ID.

Standard 1
curl -i -X DELETE \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/delete/id/656?user_email=email%40email.com&reason=Very+important&region_id=1'

Antworten

Codes wurden erfolgreich empfangen.

Bodytext/plain
string
Antwort
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

Anfrage

Löscht alle Codes anhand der Spielschlüssel-SKU.

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_emailstringerforderlich

E-Mail-Adresse des Nutzers.

Beispiel: user_email=email@email.com
reasonstringerforderlich

Grund für den Empfang von Codes.

Beispiel: reason=Very important
region_idinteger

Regions-ID.

Standard 1
curl -i -X DELETE \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/delete/sku/booster_mega_1?user_email=email%40email.com&reason=Very+important&region_id=1'

Antworten

Codes wurden erfolgreich empfangen.

Bodytext/plain
string
Antwort
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

Codes anhand der ID abrufenServer-sideAdmin

Anfrage

Ruft eine bestimmte Anzahl von Codes anhand der Spielschlüssel-ID ab.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
item_idstringerforderlich

Artikel-ID.

Beispiel: 656
Abfrage
user_emailstringerforderlich

E-Mail-Adresse des Nutzers.

Beispiel: user_email=email@email.com
quantityintegererforderlich

Codemenge.

Beispiel: quantity=100
reasonstringerforderlich

Grund für den Empfang von Codes.

Beispiel: reason=Very important
region_idinteger

Regions-ID.

Standard 1
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/request/id/656?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

Antworten

Codes wurden erfolgreich empfangen.

Bodytext/plain
string
Antwort
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3
Operationen
Operationen
Operationen
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