Zum Inhalt springen
/
Gutschein-Limit für den a...

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

Gutscheinaktion deaktivierenServer-sideAdmin

Anfrage

Deaktiviert eine Gutscheinaktion. Die erstellte Gutscheinaktion ist standardmäßig deaktiviert. Gutscheine lassen sich erst einlösen, wenn Sie die zugehörige Werbeaktion aktivieren. Verwenden Sie diesen Endpunkt, um eine Gutscheinaktion zu deaktivieren.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
external_idintegererforderlich

Externe ID der Werbeaktion. Eindeutige Werbeaktionskennung innerhalb des Projekts.

Beispiel: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/coupon/coupon_44056_1/deactivate

Antworten

Gutschein wurde erfolgreich deaktiviert.

Antwort
Kein Inhalt

Gutschein-Limit für den angegebenen Benutzer abrufenServer-sideAdmin

Anfrage

Ruft ab, wie oft der angegebene Nutzer den Gutschein noch in Anspruch nehmen kann.

Mit der entsprechenden API (User limit API) können Sie begrenzen, wie oft ein Nutzer einen Gutschein in Anspruch nehmen kann. Das Nutzerlimit können Sie im Abschnitt "Verwaltung" festlegen:

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
external_idintegererforderlich

Externe ID der Werbeaktion. Eindeutige Werbeaktionskennung innerhalb des Projekts.

Beispiel: coupon_44056_1
Abfrage
user_external_idstringerforderlich

Externe Benutzer-ID

Beispiel: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/user/limit/coupon/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Antworten

Gutschein-Limits für einen Nutzer erfolgreich erhalten.

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

Gutscheinbelohnung abrufenClient-side

Anfrage

Ruft Gutscheinbelohnungen anhand des Codes ab. Dadurch können Nutzer aus mehreren Bonusartikeln wählen. Als Normalfall gilt die Wahl eines DRM-Systems, wenn der Gutschein ein Spiel als Bonus enthält (type=unit).

Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

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

Beispiel: 44056
coupon_codestring[ 1 .. 128 ] characterserforderlich

Eindeutiger Code, es wird zwischen Groß- und Kleinschreibung unterschieden. Enthält Buchstaben und Ziffern.

Beispiel: WINTER2021
curl -i -X GET \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/coupon/code/WINTER2021/rewards \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Die Liste der Gutscheinprämien wurde erfolgreich empfangen.

Bodyapplication/json
bonusArray of objects(Promotions_200-coupon-bonus-reward)
discountobject or null(Promotions_200-coupon-discount-reward)

Prozentualer Rabatt. Der Preis des Warenkorbs wird um einen Wert verringert, der anhand dieses Prozentsatzes berechnet und dann auf zwei Dezimalstellen gerundet wird.

is_selectableboolean

Ist true eingestellt, sollte der Nutzer vor dem Einlösen eines Gutscheins den Bonus auswählen.

Antwort
application/json
{
  "bonus": [
    { … },
    { … }
  ],
  "discount": {
    "percent": "10.00"
  },
  "is_selectable": true
}

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