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

Informationen zu Webhook-Einstellungen abrufenServer-sideAdmin

Anfrage

Ruft die Informationen über die Webhook-Einstellungen in Store ab. Mehr dazu erfahren Sie in der Webhook-Dokumentation.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

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

Antworten

Informationen zu den Webhook-Einstellungen wurden erfolgreich empfangen.

Bodyapplication/json
is_enabledboolean
Beispiel: true
secretstring
Beispiel: "my_secret"
urlstring
Beispiel: "http://site.ru/webhook"
Antwort
application/json
{ "is_enabled": true, "secret": "my_secret", "url": "http://site.ru/webhook" }

Informationen zu Webhook-Einstellungen aktualisierenServer-sideAdmin

Anfrage

Aktualisiert die Informationen über die Webhook-Einstellungen in Store. Mehr dazu erfahren Sie in der Webhook-Dokumentation.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/jsonerforderlich

Informationen zu Webhook-Einstellungen.

is_enabledbooleanerforderlich

Ob Spieldienste-Webhooks aktiviert sind.

Für Spieldienste-Webhooks hat die in diesem API-Aufruf angegebene Einstellung Vorrang vor der im Kundenportal unter Projekteinstellungen > Webhooks konfigurierten Einstellung.

Beispiel: true
secretstringerforderlich

Der geheime Projektschlüssel zum Signieren von Spieldienste-Webhooks.

Für Spieldienste hat der in diesem API-Aufruf angegebene Schlüssel Vorrang vor dem im Kundenportal unter Projekteinstellungen > Webhooks generierten Schlüssel.

Beispiel: "my_secret_key"
urlstringerforderlich

URL Ihres Servers für den Empfang von Spieldienste-Webhooks. Die URL muss öffentlich zugänglich sein und das HTTPS-Protokoll verwenden, z. B.: https://example.com. Sie können auch eine URL aus einem beliebigen Webhook-Testtool angeben.

Für Spieldienste-Webhooks hat die in diesem API-Aufruf angegebene Einstellung Vorrang vor der im Kundenportal unter Projekteinstellungen > Webhooks konfigurierten Einstellung.

Beispiel: "http://site.ru/webhook"
versioninteger

Webhook-Version. In Version 2 enthält das Artikel-Array die Parameter is_free, is_bonus und is_bundle_content, die in Version 1 (Standard) nicht vorhanden sind.

Enum12
Beispiel: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "secret": "my_secret_key",
    "url": "http://site.ru/webhook",
    "version": 1
  }'

Antworten

Die Informationen zu den Webhook-Einstellungen wurden erfolgreich aktualisiert.

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