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

Anzahl der für einen bestimmten Benutzer verfügbaren Artikel erhöhenServer-sideAdmin

Anfrage

Erhöht die verbleibende Anzahl von Artikeln, die der angegebene Nutzer innerhalb des geltenden Limits noch erhalten kann.

Die entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt "Verwaltung" des gewünschten Artikeltypmoduls:

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
Bodyapplication/json
availableinteger(User-limit_available)>= 1erforderlich

Wie viele Artikel der Nutzer noch erhalten kann bzw. wie oft der Nutzer Werbeaktionen innerhalb des geltenden Limits noch in Anspruch nehmen darf.

userobject(User-limit_user)erforderlich
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$erforderlich

Externe Benutzer-ID.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Antworten

Kauflimits für einen Nutzer wurden erfolgreich empfangen.

Bodyapplication/json
per_userobject
Antwort
application/json
{ "per_user": { "available": 9, "total": 10 } }

Anzahl der für einen bestimmten Benutzer verfügbaren Artikel festlegenServer-sideAdmin

Anfrage

Legt fest, wie viele Artikel der angegebene Nutzer innerhalb des geltenden Limits kaufen kann, nachdem das Limit erhöht oder verringert wurde.

Die entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt "Verwaltung" des gewünschten Artikeltypmoduls:

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
Bodyapplication/json
availableinteger(User-limit_available_flexible)>= 0erforderlich

Wie viele Artikel der Nutzer noch erhalten kann bzw. wie oft der Nutzer Werbeaktionen innerhalb des geltenden Limits noch in Anspruch nehmen darf.

userobject(User-limit_user)erforderlich
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$erforderlich

Externe Benutzer-ID.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 0,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Antworten

Kauflimits für einen Nutzer wurden erfolgreich empfangen.

Bodyapplication/json
per_userobject
Antwort
application/json
{ "per_user": { "available": 9, "total": 10 } }

Kauflimit aktualisierenServer-sideAdmin

Anfrage

Aktualisiert das Kauflimit für einen Artikel, damit ein Nutzer ihn erneut kaufen kann. Ist dem Parameter user der Wert null zugewiesen, wird das Limit für alle Nutzer aktualisiert.

Die entsprechende API (User limit API) ermöglicht es Ihnen, festzulegen, wie viele Einheiten eines Artikels maximal erhältlich sind. Um die Kauflimits selbst zu konfigurieren, wechseln Sie zum Abschnitt "Verwaltung" des gewünschten Artikeltypmoduls:

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
Bodyapplication/json
userobject or null(User-limit_user_flexible)erforderlich
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$

Externe Benutzer-ID.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/user/limit/item/sku/booster_mega_1/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Antworten

Das Limit wurde erfolgreich aktualisiert.

Antwort
Kein Inhalt
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen