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

Anfrage

Löscht eine bestimmte Region.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
region_idintegererforderlich

Regions-ID. Eindeutige Regionskennung innerhalb des Projekts.

Beispiel: 42
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/region/42

Antworten

Region wurde erfolgreich gelöscht.

Body
Antwort
Kein Inhalt

Anfrage

Ruft eine bestimmte Region ab.

Anhand von Regionen können Sie regionale Beschränkungen verwalten.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
region_idintegererforderlich

Regions-ID. Eindeutige Regionskennung innerhalb des Projekts.

Beispiel: 42
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/region/42

Antworten

Die angegebene Region wurde erfolgreich abgerufen.

Bodyapplication/json
countriesArray of strings(Regions_countries)

Liste der Länder, die einer Region hinzugefügt werden sollen.
Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. In der Dokumentation finden Sie ausführliche Informationen zu den von Xsolla unterstützten Ländern.
Beispiel: ["JP", "CN", "VN"]

idinteger(Regions_region_id)

Regions-ID. Eindeutige Regionskennung innerhalb des Projekts.

Beispiel: 42
nameobject(Regions_name)

Name der Region. Sollte Schlüssel-Wert-Paare enthalten, wobei der Schlüssel ein Gebietsschema im Format "^[a–z]{2}-[A–Z]{2}$" und der Wert ein String ist.

Standard {"de-DE":"Asien","en-US":"Asia"}
Beispiel: {"de-DE":"Asien","en-US":"Asia"}
Antwort
application/json
{ "value": { "countries": [], "id": 44, "name": {} } }

Region aktualisierenServer-sideAdmin

Anfrage

Aktualisiert eine bestimmte Region.

Anhand von Regionen können Sie regionale Beschränkungen verwalten.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
region_idintegererforderlich

Regions-ID. Eindeutige Regionskennung innerhalb des Projekts.

Beispiel: 42
Bodyapplication/json
countriesArray of strings(Regions_countries)erforderlich

Liste der Länder, die einer Region hinzugefügt werden sollen.
Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. In der Dokumentation finden Sie ausführliche Informationen zu den von Xsolla unterstützten Ländern.
Beispiel: ["JP", "CN", "VN"]

nameobject(Regions_name)erforderlich

Name der Region. Sollte Schlüssel-Wert-Paare enthalten, wobei der Schlüssel ein Gebietsschema im Format "^[a–z]{2}-[A–Z]{2}$" und der Wert ein String ist.

Standard {"de-DE":"Asien","en-US":"Asia"}
Beispiel: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*stringzusätzliche Eigenschaft
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/region/42 \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

Antworten

Region wurde erfolgreich aktualisiert.

Body
Antwort
Kein Inhalt
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
Operationen
Operationen
Operationen
Operationen
Operationen