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

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

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

Personalisierter Katalog

Diese API ermöglicht es, Regeln für Benutzerattribute festzulegen. Wenn der Nutzer alle Bedingungen einer konkreten Regel erfüllt, werden personalisierte Artikel angezeigt.

Für personalisierte Werbeaktionen siehe Abschnitt Werbeaktionen.

Um Attribute vor einem Kauf zu übermitteln, können Sie die Xsolla Login API verwenden oder die Attribute in der Eigenschaft user.attributes übermitteln, während Sie den Token mit der Pay Station API generieren.

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
Operationen

Berechtigung entziehen (Verwaltung)Server-sideAdmin

Anfrage

Entzieht dem Nutzer eine Berechtigung.

Achtung

Es können nur Spielcodes oder Spiele für DRM-freie Plattformen entzogen werden.
Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/jsonerforderlich
drmobjecterforderlich

Objekt mit DRM-Eigenschaften.

Beispiel: {"sku":"com.xsolla.key_1"}
drm.​skustring(Game-Keys_drm_sku)erforderlich

Eindeutige DRM-ID.

Enum"steam""playstation""xbox""uplay""origin""drmfree""gog""epicgames""nintendo_eshop""discord_game_store"
Beispiel: "steam"
gameobjecterforderlich

Objekt mit Spieleigenschaften.

Beispiel: {"sku":"com.xsolla.game_1"}
game.​skustring(Game-Keys_game_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$erforderlich

Eindeutige Schlüsselpaket-ID.

Beispiel: "theGreatestGameSku"
modestringerforderlich

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

Eindeutige Benutzerkennung.

Beispiel: "user-external-id"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/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"
  }'

Antworten

Widerruf erfolgreich.

Antwort
Kein Inhalt

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/shop-builder/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/shop-builder/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

Gutscheine

Mit dieser API können Sie Gutscheine verwalten.

Operationen

Promocodes

Diese API ermöglicht die Verwaltung von Promocodes.

Operationen

Katalogsonderangebote

Mit dieser API können Sie Katalogsonderangebote verwalten.

Operationen

Rabatte

Mit dieser API können Sie Rabattaktionen verwalten.

Operationen

Boni

Diese API ermöglicht die Verwaltung von Bonusaktionen.

Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen