Zum Inhalt springen
/
Tägliche Belohnung abrufe...

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

Verwaltung

Operationen

Tägliche Belohnung löschenServer-sideAdmin

Anfrage

Löscht eine bestimmte tägliche Belohnung.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
daily_chain_idintegererforderlich

ID der täglichen Belohnung.

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

Antworten

Tägliche Belohnung wurde erfolgreich gelöscht.

Body
Antwort
Kein Inhalt

Tägliche Belohnung abrufenServer-sideAdmin

Anfrage

Ruft eine bestimmte tägliche Belohnung zur Verwaltung ab.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
daily_chain_idintegererforderlich

ID der täglichen Belohnung.

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

Antworten

Belohnungsdaten wurden erfolgreich abgerufen.

Bodyapplication/json
date_startstring(date-time)(calendar_hard_date_start)

Datum, an dem die tägliche Belohnung beginnt.

Beispiel: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

Ob die tägliche Belohnung wiederkehrend ist. Ist true festgelegt, wird die tägliche Belohnung nach dem Enddatum automatisch zurückgesetzt. Das nächste start_date und end_date basiert auf der Anzahl der Belohnungsschritte und dem eingestellten Anfangszeitpunkt (start_date).

Standard false
Beispiel: true
typestring

Belohnungstyp, der festlegt, wann Nutzer Belohnungen beanspruchen können.

Enum WertBeschreibung
calendar_hard

Schaltet alle 24 Stunden die nächste Schrittbelohnung frei. Nicht beanspruchte Schrittbelohnungen verfallen endgültig, sobald die nächste Schrittbelohnung verfügbar wird.

rolling_skippable

Schaltet alle 24 Stunden die nächste Schrittbelohnung basierend auf dem date_start frei. Der Fortschritt erfolgt schrittweise: Eine neue Belohnung wird erst freigeschaltet, wenn die vorherige beansprucht wurde. Wenn ein Nutzer einen oder mehrere Tage auslässt, setzt er an der Stelle fort, an der er aufgehört hat; für ausgelassene Tage werden keine mehrfachen Belohnungen vergeben.

rolling_unskippable

Schaltet alle 24 Stunden die nächste Schrittbelohnung basierend auf dem date_start frei. Der Fortschritt erfolgt schrittweise: Eine neue Belohnung wird erst freigeschaltet, wenn die vorherige beansprucht wurde. Wenn ein Nutzer jedoch einen Tag auslässt, wird der Fortschritt zurückgesetzt, und der Nutzer muss wieder beim ersten Schritt beginnen.

Diskriminator
date_endstring or null(date-time)(daily_chain_date_end)

Datum, an dem die tägliche Belohnung endet. Möglich ist null. Ist der Typ calendar_hard festgelegt, wird das Datum automatisch anhand der hinzugefügten Schritte ermittelt, sodass Sie dieses Feld auf null belassen können.

Beispiel: "2020-04-15T18:16:00+05:00"
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

Objekt mit Lokalisierungen für Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

One of:

Objekt mit Lokalisierungen für Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

idinteger(daily_chain_id)

Eindeutige ID der täglichen Belohnung.

Beispiel: 9
is_enabledboolean(is_enabled)
Beispiel: true
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)

Objekt mit Lokalisierungen für Artikelnamen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

One of:

Objekt mit Lokalisierungen für Artikelnamen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

number_of_stepsinteger(daily_chain_number_of_step)

Die im Rahmen der Belohnungskette festgelegte Anzahl der Schritte. Jeder Schritt steht hier für einen Tag.

Beispiel: 3
orderinteger(order)

Definiert die Anordnungsreihenfolge.

Beispiel: 1
stepsArray of objects(admin-daily-chain-step-model)
Antwort
application/json
{
  "date_end": "2025-04-25T18:16:00+05:00",
  "date_start": "2023-04-15T18:16:00+05:00",
  "description": {
    "en": "Daily reward short description"
  },
  "id": 3,
  "is_enabled": true,
  "is_recurrent": false,
  "name": {
    "en": "Daily reward",
    "ru": "Ежедневная награда"
  },
  "number_of_steps": 3,
  "order": 1,
  "steps": [
    { … },
    { … },
    { … }
  ],
  "type": "calendar_hard"
}

Tägliche Belohnung aktualisierenServer-sideAdmin

Anfrage

Aktualisiert eine bestimmte tägliche Belohnung.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
daily_chain_idintegererforderlich

ID der täglichen Belohnung.

Beispiel: 101
Bodyapplication/json
One of:

Eine tägliche Belohnung für den Typ calendar_hard.

date_startstring(date-time)(calendar_hard_date_start)erforderlich

Datum, an dem die tägliche Belohnung beginnt.

Beispiel: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

Ob die tägliche Belohnung wiederkehrend ist. Ist true festgelegt, wird die tägliche Belohnung nach dem Enddatum automatisch zurückgesetzt. Das nächste start_date und end_date basiert auf der Anzahl der Belohnungsschritte und dem eingestellten Anfangszeitpunkt (start_date).

Standard false
Beispiel: true
typestringerforderlich

Belohnungstyp, der festlegt, wann Nutzer Belohnungen beanspruchen können.

Enum WertBeschreibung
calendar_hard

Schaltet alle 24 Stunden die nächste Schrittbelohnung frei. Nicht beanspruchte Schrittbelohnungen verfallen endgültig, sobald die nächste Schrittbelohnung verfügbar wird.

rolling_skippable

Schaltet alle 24 Stunden die nächste Schrittbelohnung basierend auf dem date_start frei. Der Fortschritt erfolgt schrittweise: Eine neue Belohnung wird erst freigeschaltet, wenn die vorherige beansprucht wurde. Wenn ein Nutzer einen oder mehrere Tage auslässt, setzt er an der Stelle fort, an der er aufgehört hat; für ausgelassene Tage werden keine mehrfachen Belohnungen vergeben.

rolling_unskippable

Schaltet alle 24 Stunden die nächste Schrittbelohnung basierend auf dem date_start frei. Der Fortschritt erfolgt schrittweise: Eine neue Belohnung wird erst freigeschaltet, wenn die vorherige beansprucht wurde. Wenn ein Nutzer jedoch einen Tag auslässt, wird der Fortschritt zurückgesetzt, und der Nutzer muss wieder beim ersten Schritt beginnen.

description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

Objekt mit Lokalisierungen für Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

One of:

Objekt mit Lokalisierungen für Artikelbeschreibungen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

idinteger(daily_chain_id)

Eindeutige ID der täglichen Belohnung.

Beispiel: 9
is_enabledboolean(is_enabled)erforderlich
Beispiel: true
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)erforderlich

Objekt mit Lokalisierungen für Artikelnamen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

One of:

Objekt mit Lokalisierungen für Artikelnamen. Werte können in zwei Formaten angegeben werden: Sprachencode bestehend aus zwei Kleinbuchstaben (z. B. en) oder fünfstelliger Gebietsschemacode (z. B. en-US). Beide Formate werden als Eingabe akzeptiert, als Antwort werden jedoch stets zweistellige Sprachencodes in Kleinbuchstaben zurückgegeben. Wenn für dieselbe Sprache beide Optionen angegeben sind (z. B. en und en-US), wird der zuletzt angegebene Wert gespeichert. Die vollständige Liste der unterstützten Sprachen finden Sie in der Dokumentation.

name.​arstring or null

Arabisch

name.​bgstring or null

Bulgarisch

name.​cnstring or null

Chinesisch (vereinfacht)

name.​csstring or null

Tschechisch

name.​destring or null

Deutsch

name.​enstring or null

Englisch

name.​esstring or null

Spanisch (Spanien)

name.​frstring or null

Französisch

name.​hestring or null

Hebräisch

name.​idstring or null

Indonesisch

name.​itstring or null

Italienisch

name.​jastring or null

Japanisch

name.​kmstring or null

Khmer

name.​kostring or null

Koreanisch

name.​lostring or null

Laotisch

name.​mystring or null

Birmanisch

name.​nestring or null

Nepalesisch

name.​phstring or null

Filipino

name.​plstring or null

Polnisch

name.​ptstring or null

Portugiesisch

name.​rostring or null

Rumänisch

name.​rustring or null

Russisch

name.​thstring or null

Thai

name.​trstring or null

Türkisch

name.​twstring or null

Chinesisch (traditionell)

name.​vistring or null

Vietnamesisch

orderinteger(order)

Definiert die Anordnungsreihenfolge.

Beispiel: 1
stepsArray of objects(modify-daily-chain-step-model)erforderlich
steps[].​itemsArray of objects(modify-daily-chain-item-model)non-emptyerforderlich
steps[].​items[].​quantityinteger>= 1erforderlich

Menge der täglichen Belohnung für diese SKU

steps[].​items[].​skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$erforderlich

Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

Beispiel: "booster_mega_1"
steps[].​step_idinteger or null(daily_chain_update_step_id)>= 1

Eindeutige Kennung des Belohnungsschritts. Geben Sie die ID während der Aktualisierung an, damit der Nutzerfortschritt für diesen Schritt nicht verloren geht.

Beispiel: 10
steps[].​step_numberinteger(daily_chain_step_number)>= 1erforderlich

Schrittnummer.

Beispiel: 2
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/de/api/shop-builder/v2/project/44056/admin/daily_chain/id/101 \
  -H 'Content-Type: application/json' \
  -d '{
    "date_start": "2023-04-15T18:16:00+05:00",
    "description": {
      "en": "Updated daily reward description"
    },
    "is_enabled": true,
    "name": {
      "en": "Updated daily reward",
      "ru": "Обновленная ежедневная награда"
    },
    "order": 4,
    "steps": [
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_enabled_shown_in_store_1"
          }
        ],
        "step_number": 1
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_enabled_shown_in_store_2"
          }
        ],
        "step_number": 2
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_not_shown_in_store"
          }
        ],
        "step_id": 10,
        "step_number": 3
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
          }
        ],
        "step_id": 8,
        "step_number": 4
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
          }
        ],
        "step_number": 5
      }
    ],
    "type": "calendar_hard"
  }'

Antworten

Tägliche Belohnung wurde erfolgreich aktualisiert.

Body
Antwort
Kein Inhalt

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen