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

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 }

Bestellung für kostenpflichtigen Angebotskettenschritt anlegenClient-side

Anfrage

Legt eine Bestellung für den Artikel an, der mit dem angegebenen kostenpflichtigen Angebotskettenschritt verknüpft ist. Der angelegten Bestellung wird der Status new zugewiesen.

Öffnen Sie das Zahlungsportal in einem neuen Fenster mithilfe des folgenden Links: https://secure.xsolla.com/paystation4/?token={token}, wobei {token} der erhaltene Token ist.

Für Testzwecke steht Ihnen die folgende URL zur Verfügung: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Hinweis

Diese Methode muss clientseitig verwendet werden. Anhand der IP-Adresse des Nutzers wird das Land ermittelt und davon wiederum die Währung und die verfügbaren Zahlungsmethoden abgeleitet. Wird diese Methode serverseitig verwendet, wird mögliccherweise eine falsche Währung ermittelt, was sich wiederum auf die Zahlungsmethoden in Pay Station auswirkt.

Hinweis

Verwenden Sie diesen Aufruf nur bei kostenpflichtigen Schritten in der Angebotskette. Bei kostenlosen Schritten müssen Sie stattdessen den Aufruf Kostenlosen Angebotskettenschritt sichern 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/order \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Bestellung wurde erfolgreich erstellt.

Bodyapplication/json
order_idinteger

Bestell-ID.

tokenstring

Zahlungstoken.

Antwort
application/json
{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }
Operationen
Operationen
Operationen
Operationen
Operationen