Zum Inhalt springen

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Catalog API bietet Endpunkte zur Verwaltung Ihres In-Game-Store-Katalogs und zur Abwicklung von Käufen. Verwenden Sie die Endpunkte zum Konfigurieren von virtuellen Gegenständen, virtuellen Währungen, Spielschlüsseln, Bundles, Warenkorb- und Zahlungsabläufen sowie Artikelattributen und zum Importieren von Artikeln aus externen Quellen.

OpenAPI-Beschreibung herunterladen
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/catalog/
https://store.xsolla.com/api/
Operationen
Operationen
Operationen
Operationen
Operationen

Liste der Spiele im Besitz des Nutzers abrufenClient-side

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.
Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Abfrage
limitinteger>= 1

Begrenzung der Elementanzahl auf der Seite.

Beispiel: limit=50
offsetinteger>= 0

Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).

Beispiel: offset=0
sandboxinteger

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
additional_fields[]Array of strings

Die Liste der zusätzlichen Felder. Diese Felder sind in der Antwort enthalten, sofern Sie diese in der Anfrage senden. Verfügbare Felder: attributes.

curl -i -X GET \
  'https://xsolla.redocly.app/_mock/de/api/catalog/v2/project/44056/entitlement?limit=50&offset=0&sandbox=0&additional_fields%5B%5D=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Erfolgreicher Empfang einer Liste von Spielschlüsseln, die dem Nutzer gehören.

Bodyapplication/json
has_moreboolean(Pagination_has-more)

Dient als Indikator dafür, dass weitere Seiten vorhanden sind.

Beispiel: true
itemsArray of objects(Game-Keys_entitlement_item)
total_items_countinteger(Pagination_total-items-count)

Gesamtzahl der Artikel im System.

Beispiel: 10
Antwort
application/json
{ "has_more": false, "items": [ {} ], "total_items_count": 1 }

Spielcode durch Client einlösenClient-side

Anfrage

Gewährt die Berechtigung anhand des bereitgestellten Spielcodes.

Achtung

Sie können Codes nur für die DRM-freie Plattform einlösen.
Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/jsonerforderlich
codestringerforderlich

Spielcode.

Beispiel: "AAAA-BBBB-CCCC-DDDD"
sandboxboolean

Löst den Spielcode in der Testumgebung ein. Die Option steht den Nutzern offen, die in der Liste der Firmennutzer aufgeführt sind.

Standard false
Beispiel: false
curl -i -X POST \
  https://xsolla.redocly.app/_mock/de/api/catalog/v2/project/44056/entitlement/redeem \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "AAAA-BBBB-CCCC-DDDD",
    "sandbox": false
  }'

Antworten

Erfolgreiche Einlösung.

Antwort
Kein Inhalt
Operationen
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