Zum Inhalt springen

Shop Builder API (2.0.0)

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
index.json
index.yaml
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/shop-builder/
https://store.xsolla.com/api/

Verwaltung

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

Liste der Katalogfilterregeln abrufenServer-sideAdmin

Anfrage

Ruft alle Regeln ab, die für Benutzerattribute gelten.

Sicherheit
basicAuth
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
is_enabledinteger

Elemente nach is_enabled-Flag filtern.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/user/attribute/rule?limit=50&offset=0&is_enabled=0'

Antworten

Regeln wurden erfolgreich empfangen.

Bodyapplication/json
has_moreboolean

Wenn eine andere Seite mit Regeln existiert.

itemsArray of objects(user-attribute_personalized-catalog)
total_items_countnumber

Gesamtzahl der Regeln.

Antwort
application/json
{
  "has_more": true,
  "items": [
    { … }
  ],
  "total_items_count": 20
}

Katalogfilterregel erstellenServer-sideAdmin

Anfrage

Erstellt Regeln für Benutzerattribute.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] itemserforderlich

Bedingungen für die Validierung von Nutzerattributen. Steuert die Artikelverfügbarkeit im Katalog basierend darauf, ob die Nutzerattribute alle angegebenen Bedingungen erfüllen.

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$erforderlich

Benutzerattributcode.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

Gibt an, dass die Bedingung erfüllt ist, auch wenn das Attribut in den Benutzerattributen fehlt. Übermitteln Sie true, um den Artikel den Nutzern anzuzeigen, die dieses Attribut nicht haben. Nutzer, die das Attribut haben, dessen Wert jedoch nicht mit dem in der Bedingung angegebenen Wert übereinstimmt, sehen den Artikel nicht. false – Nutzer, die das Attribut haben, dessen Wert jedoch nicht mit dem in der Bedingung angegebenen Wert übereinstimmt oder bei denen das Attribut fehlt, sehen den Artikel nicht.

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)erforderlich

Art der durchgeführten Operation nach Bedingung. Für den Attributtyp string.

Enum WertBeschreibung
eq

Gleich

ne

Ungleich

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)erforderlich

Benutzerattributtyp.

Wert"string"
attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 characterserforderlich

Bedingungswert, mit dem der Benutzerattributwert verglichen wird. Der Typ hängt vom Attributtyp ab.

is_enabledbooleanerforderlich

Wenn die Regel aktiviert ist.

is_satisfied_for_unauthboolean

Ob der Artikel nicht autorisierten Nutzern angezeigt wird. Ist true festgelgt, wird der Artikel dem nicht autorisierten Nutzer unabhängig von den Kataloganzeigeregeln angezeigt. Standardmäßig ist false festgelgt.

itemsArray of objects[ 1 .. 100 ] itemserforderlich
One of:

Artikel, die einem Nutzer angezeigt werden, sofern ihre Attributwerte Bedingungen erfüllen.

items[].​item_idnumbererforderlich

Artikel-ID.

namestring[ 1 .. 255 ] characters^\Serforderlich

Verständlicher Name einer Regel. Dient dazu, eine Regel im Kundenportal anzuzeigen.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/user/attribute/rule \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "ork"
      }
    ],
    "is_enabled": true,
    "is_satisfied_for_unauth": false,
    "items": [
      {
        "item_id": 1
      }
    ],
    "name": "Ork race armor rule"
  }'

Antworten

Regel wurde erfolgreich erstellt.

Bodyapplication/json
rule_idnumber

Regel-ID.

Antwort
application/json
{
  "rule_id": 1
}

Alle Katalogregeln zum clientseitigen Durchsuchen abrufenServer-sideAdmin

Anfrage

Ruft eine Liste aller Katalogregeln zum clientseitigen Durchsuchen ab.

Achtung

Gibt nur die Regel-ID, den Namen und is_enabled zurück
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://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/user/attribute/rule/all

Antworten

Regeln wurden erfolgreich empfangen.

Bodyapplication/json
itemsArray of objects(user-attribute_personalized-catalog_all)
Antwort
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Verwaltung

Operationen

Katalog

Operationen

Warenkorb (clientseitig)

Operationen

Warenkorb (serverseitig)

Operationen

Zahlung (clientseitig)

Operationen

Zahlung (serverseitig)

Operationen

Bestellung

Operationen

Kostenlose Artikel

Operationen

Webhooks

Operationen

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

Katalog

Operationen

Berechtigung

Operationen

Verwaltung

Operationen

Allgemeines

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

Verwaltung

Operationen

Katalog

Operationen

Virtuelle Bezahlung

Operationen

Verwaltung

Operationen

Verwaltung

Operationen

Client

Operationen

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen