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

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

Angebotsketten des aktuellen Nutzers abrufenClient-side

Anfrage

Ruft die aktuellen Angebotsketten des Nutzers ab.

Hinweis

In allen Projekten ist die Anzahl der Artikel, die in einer einzigen Antwort zurückgegeben werden können, begrenzt. Der Standard- und Maximalwert beträgt 30 Artikel pro Antwort. Verwenden Sie die Abfrageparameter limit und offset für die Paginierung, um weitere Daten abzurufen.
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/offer_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Die Liste der Angebotsketten wurde erfolgreich empfangen.

Bodyapplication/json
has_moreboolean

Gibt an, ob weitere Seiten verfügbar sind.

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

Gesamtzahl der verfügbaren Angebotsketten.

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

Angebotskette des aktuellen Nutzers anhand der ID abrufenClient-side

Anfrage

Ruft die Angebotskette des aktuellen Nutzers anhand der Angebotsketten-ID ab.

Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

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

Beispiel: 44056
offer_chain_idintegererforderlich

Angebotsketten-ID.

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

Antworten

Die Angebotskette des Nutzers wurde erfolgreich abgerufen.

Bodyapplication/json
date_endstring or null(date-time)(offer_chain_date_end)

Datum, an dem die Angebotskette endet. Kann null sein. Wenn für date_end der Wert null festgelegt ist, ist die Angebotskette zeitlich unbegrenzt.

Beispiel: "2020-04-15T18:16:00+05:00"
date_startstring(date-time)(offer_chain_date_start)

Datum, an dem die Angebotskette beginnt.

Beispiel: "2020-04-15T18:16:00+05:00"
descriptionstring or null

Angebotskettenbeschreibung.

Beispiel: "Major weekly quest"
idinteger

Angebotsketten-ID.

Beispiel: 9
namestring

Angebotskettenname.

Beispiel: "Weekly quest"
next_step_numberinteger or null

Nächste Angebotskettenschritt-Nummer. null, wenn die Angebotskette abgeschlossen ist.

Beispiel: 1
orderinteger(order)

Definiert die Anordnungsreihenfolge.

Beispiel: 1
recurrent_scheduleobject or null(offer_chain_recurrent_schedule_client_side)

Reset-Zeitraum der Angebotskette.

stepsArray of objects(client-offer-chain-step-model)
Antwort
application/json
{
  "date_end": "2025-04-25T18:16:00+05:00",
  "date_start": "2010-04-15T18:16:00+05:00",
  "description": null,
  "id": 4,
  "name": "Offer chain with bundles",
  "next_step_number": 1,
  "order": 1,
  "recurrent_schedule": null,
  "steps": [
    { … },
    { … }
  ]
}

Kostenlosen Angebotskettenschritt sichernClient-side

Anfrage

Schließt den aktuellen Fortschritt des Nutzers in der Angebotskette ab und gewährt die zugehörige Belohnung.

Hinweis

Verwenden Sie diesen Aufruf nur bei kostenlosen Schritten in der Angebotskette. Bei Schritten, die eine Zahlung in echter Währung erfordern, müssen Sie stattdessen den Aufruf Bestellung für kostenpflichtigen Angebotskettenschritt anlegen verwenden.
Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

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

Beispiel: 44056
offer_chain_idintegererforderlich

Angebotsketten-ID.

Beispiel: 101
step_numberintegererforderlich

Nummer des Angebotskettenschritts.

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

Antworten

Der kostenlose Schritt wurde erfolgreich in Anspruch genommen und die Belohnung gewährt.

Bodyapplication/json
order_idinteger

Bestell-ID.

Antwort
application/json
{
  "order_id": 641
}

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen