Zum Inhalt springen
/
Wertpunktestand des aktue...

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

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

Belohnungsketten des aktuellen Nutzers abrufenClient-side

Anfrage

Client-Endpunkt. Ruft die Belohnungsketten des aktuellen Nutzers ab.

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
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/user/reward_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Die Belohnungskette des Nutzers wurde erfolgreich abgerufen.

Bodyapplication/json
has_moreboolean

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

Beispiel: true
itemsArray of objects(client-reward-chain-item-model)
total_items_countinteger

Gesamtzahl der Belohnungsketten im System.

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

Wertpunktestand des aktuellen Nutzers abrufenClient-side

Anfrage

Client-Endpunkt. Ruft den Wertpunktestand des aktuellen Nutzers ab.

Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

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

Beispiel: 44056
reward_chain_idintegererforderlich

Belohnungsketten-ID.

Beispiel: 101
curl -i -X GET \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/user/reward_chain/101/balance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Der Wertpunktestand des Nutzers wurde erfolgreich abgerufen.

Bodyapplication/json
amountinteger

Wertpunktmenge.

descriptionstring or null(value-point-description)

Beschreibung des Wertpunktes.

image_urlstring(Common_admin-image_url)

Bild-URL.

Beispiel: "https://image.example.com"
is_clanboolean(is_clan)

Ob der Wertpunkt in Clan-Belohnungsketten verwendet wird.

Beispiel: true
long_descriptionstring or null(value-point-long-description)

Lange Beschreibung des Wertpunkts.

namestring(value-point-name)

Wertpunktname.

skustring(value-point-sku)

Eindeutige ID des Wertpunkts.

Antwort
application/json
{
  "amount": 80,
  "description": "Value points for clan reward system.",
  "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
  "is_clan": true,
  "long_description": "Value points given to clans to get new rewards in a reward chain.",
  "name": "Clan Reward VP 1",
  "sku": "com.xsolla.clan_value_point_1"
}

Schrittbelohnung gewährenClient-side

Anfrage

Client-Endpunkt. Gewährt dem aktuellen Nutzer die Schrittbelohnung aus einer Belohnungskette.

Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

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

Beispiel: 44056
reward_chain_idintegererforderlich

Belohnungsketten-ID.

Beispiel: 101
step_idintegererforderlich

ID des Belohnungskettenschritts.

Beispiel: 120
curl -i -X POST \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/user/reward_chain/101/step/120/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Dem aktuellen Nutzer wurde die Schrittbelohnung aus einer Belohnungskette erfolgreich gewährt.

Antwort
Kein Inhalt

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen