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

Informationen zu Webhook-Einstellungen abrufenServer-sideAdmin

Anfrage

Ruft die Informationen über die Webhook-Einstellungen in Store ab. Mehr dazu erfahren Sie in der Webhook-Dokumentation.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook

Antworten

Informationen zu den Webhook-Einstellungen wurden erfolgreich empfangen.

Bodyapplication/json
is_enabledboolean
Beispiel: true
secretstring
Beispiel: "my_secret"
urlstring
Beispiel: "http://site.ru/webhook"
Antwort
application/json
{
  "is_enabled": true,
  "secret": "my_secret",
  "url": "http://site.ru/webhook"
}

Informationen zu Webhook-Einstellungen aktualisierenServer-sideAdmin

Anfrage

Aktualisiert die Informationen über die Webhook-Einstellungen in Store. Mehr dazu erfahren Sie in der Webhook-Dokumentation.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/jsonerforderlich

Informationen zu Webhook-Einstellungen.

is_enabledbooleanerforderlich

Ob Spieldienste-Webhooks aktiviert sind.

Für Spieldienste-Webhooks hat die in diesem API-Aufruf angegebene Einstellung Vorrang vor der im Kundenportal unter Projekteinstellungen > Webhooks konfigurierten Einstellung.

Beispiel: true
secretstringerforderlich

Der geheime Projektschlüssel zum Signieren von Spieldienste-Webhooks.

Für Spieldienste hat der in diesem API-Aufruf angegebene Schlüssel Vorrang vor dem im Kundenportal unter Projekteinstellungen > Webhooks generierten Schlüssel.

Beispiel: "my_secret_key"
urlstringerforderlich

URL Ihres Servers für den Empfang von Spieldienste-Webhooks. Die URL muss öffentlich zugänglich sein und das HTTPS-Protokoll verwenden, z. B.: https://example.com. Sie können auch eine URL aus einem beliebigen Webhook-Testtool angeben.

Für Spieldienste-Webhooks hat die in diesem API-Aufruf angegebene Einstellung Vorrang vor der im Kundenportal unter Projekteinstellungen > Webhooks konfigurierten Einstellung.

Beispiel: "http://site.ru/webhook"
versioninteger

Webhook-Version. In Version 2 enthält das Artikel-Array die Parameter is_free, is_bonus und is_bundle_content, die in Version 1 (Standard) nicht vorhanden sind.

Enum12
Beispiel: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "secret": "my_secret_key",
    "url": "http://site.ru/webhook",
    "version": 1
  }'

Antworten

Die Informationen zu den Webhook-Einstellungen wurden erfolgreich aktualisiert.

Antwort
Kein Inhalt

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