Spielcode des Spiels.
- Berechtigung erteilen (Verwaltung)
Berechtigung entziehen (Verwaltung)
Liste der Spiele im Besitz des Nutzers abrufen
Spielcode durch Client einlösen
Berechtigung erteilen (Ve...
Katalog-API (2.0.0)
- 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.
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/
Pfad
Bodyapplication/jsonerforderlichProjekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Objekt mit DRM-Eigenschaften.
Beispiel: {"sku":"com.xsolla.key_1"}
Objekt mit Spieleigenschaften.
Beispiel: {"sku":"com.xsolla.game_1"}
Welche Art von Berechtigungen erteilt werden soll. Ist der Parameter auf sandbox gesetzt wird dem Nutzer in der Testumgebung die Berechtigung erteilt. Ist der Parameter auf default gesetzt, wird die Berechtigung dem Nutzer im Live-Modus erteilt.
Enum"default""sandbox"
Beispiel: "default"
- https://store.xsolla.com/api/v2/project/{project_id}/admin/entitlement/grant
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/catalog/v2/project/{project_id}/admin/entitlement/grant
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/entitlement/grant \
-H 'Content-Type: application/json' \
-d '{
"code": "AAAA-BBBB-CCCC-DDDD",
"drm": {
"sku": "com.xsolla.key_1"
},
"game": {
"sku": "com.xsolla.game_1"
},
"mode": "default",
"user_country": "US",
"user_external_id": "user-external-id"
}'Pfad
Bodyapplication/jsonerforderlichProjekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Objekt mit DRM-Eigenschaften.
Beispiel: {"sku":"com.xsolla.key_1"}
Objekt mit Spieleigenschaften.
Beispiel: {"sku":"com.xsolla.game_1"}
Welche Art von Berechtigungen entzogen werden soll. Ist der Parameter auf sandbox gesetzt wird dem Nutzer in der Testumgebung die Berechtigung entzogen. Ist der Parameter auf default gesetzt, wird die Berechtigung dem Nutzer im Live-Modus entzogen.
Enum"default""sandbox"
Beispiel: "default"
- https://store.xsolla.com/api/v2/project/{project_id}/admin/entitlement/revoke
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/catalog/v2/project/{project_id}/admin/entitlement/revoke
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/entitlement/revoke \
-H 'Content-Type: application/json' \
-d '{
"drm": {
"sku": "com.xsolla.key_1"
},
"game": {
"sku": "com.xsolla.game_1"
},
"mode": "default",
"user_external_id": "user-external-id"
}'Anfrage
Ruft eine Liste der Spiele ab, die der Nutzer besitzt. Als Antwort enthält man ein Array von Spielen, die ein bestimmter Nutzer besitzt.
Achtung
Bei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.
Bei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 50 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.
Sicherheit
XsollaLoginUserJWT
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Abfrage
Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).
Beispiel: offset=0
Welche Arten von Berechtigungen zurückgegeben werden sollen. Ist der Parameter auf 1 gesetzt, werden nur die Berechtigungen zurückgegeben, die der Nutzer in der Testumgebung erhalten hat. Falls der Parameter nicht übermittelt wird oder auf 0 gesetzt ist, werden nur die Berechtigungen zurückgegeben, die der Nutzer im Live-Modus erhalten hat.
Standard 0
- https://store.xsolla.com/api/v2/project/{project_id}/entitlement
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/catalog/v2/project/{project_id}/entitlement
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/entitlement?limit=50&offset=0&sandbox=0&additional_fields%5B%5D=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Antwort
application/json
{ "has_more": false, "items": [ { … } ], "total_items_count": 1 }