Zum Inhalt springen
/
Tägliche Belohnungen des...

LiveOps API (2.0.0)

Überblick

  • Version: 2.0.0
  • Server: https://store.xsolla.com/api
  • Kontakt per E-Mail
  • Kontakt-URL: https://xsolla.com/
  • Erforderliche TLS-Version: 1.2

LiveOps ist ein Toolkit, mit dem sich durch Werbeaktionen und personalisierte Angebote die Spielerbindung kontinuierlich verbessern lässt.

Mit der API lassen sich die folgenden Funktionen verwalten:

  • Werbeaktionen – Erstellen und verwalten Sie Gutscheine, Promocodes, Rabatte und Bonusaktionen.
  • Personalisierung – Legen Sie für bestimmte autorisierte Nutzer Bedingungen fest, gemäß denen der Artikelkatalog und Sonderangebote angezeigt werden sollen.
  • Werbaktionslimits – Begrenzen Sie, wie oft ein Nutzer eine Werbeaktion in Anspruch nehmen darf, und legen Sie fest, wie häufig das Limit zurückgesetzt werden soll.
  • Belohnungsketten und Wertpunkte – Konfigurieren Sie Belohnungsstufen, die an das Sammeln von Wertpunkten geknüpft sind.
  • Tägliche Ketten – Richten Sie tägliche Belohnungen ein, um Nutzer zu motivieren, sich regelmäßig anzumelden.
  • Angebotsketten – Erstellen Sie aufeinander aufbauende Kaufangebote mit gestaffelten Preisen und optionalen kostenlosen Belohnungen.
  • Upselling – eine Verkaufsmethode, bei der dem Nutzer angeboten wird, einen Artikel mit einem Mehrwert zu erwerben.

API-Aufrufe

Die API ist in die folgenden Gruppen unterteilt:

  • Admin – Aufrufe zum Erstellen, Aktualisieren, Aktivieren und Löschen von Kampagnen und Ketten. Die Authentifizierung erfolgt über die Basisauthentifizierung und Ihre Händler- oder Projekt-Anmeldedaten.
  • Client – Aufrufe zum Abrufen verfügbarer Werbeaktionen, zum Abrufen aktiver Ketten, zum Einlösen von Codes und zur Inanspruchnahme von Belohnung im Namen authentifizierter Nutzer. Die Authentifizierung erfolgt über den Benutzer-JWT.
OpenAPI-Beschreibung herunterladen
index.json
index.yaml
Sprachen
Server
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/de/api/liveops/

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

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

Verwaltung

Operationen

Client

Operationen

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Tägliche Belohnungen des aktuellen Nutzers abrufenClient-side

Anfrage

Client-Endpunkt. Ruft die täglichen Belohnungen des aktuellen Nutzers ab.

Hinweis

Die Methode gibt eine paginierte Artikelliste zurück. Der Maximal- und Standardwert beträgt 50 Artikel pro Antwort. Verwenden Sie die Parameter `limit` und `offset`, um weitere Seiten bzw. Artikel aus der Liste abzurufen. Wenn Sie beispielsweise die Methode mit den Parameterwerten "limit = 25" und "offset = 100" aufrufen, sind in der Antwort 25 Artikel aufgeführt, beginnend mit dem 101. Artikel in der Gesamtliste.
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://store.xsolla.com/api/v2/project/44056/user/daily_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Die täglichen Belohnungen des Nutzers wurden erfolgreich abgerufen.

Bodyapplication/json
has_moreboolean

Dient als Indikator dafür, dass weitere Seiten vorhanden sind.

Beispiel: true
itemsArray of any(client-daily-chain-model)
total_items_countinteger

Gesamtzahl der täglichen Belohnungen.

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

Tägliche Belohnung des aktuellen Nutzers anhand der Belohnungs-ID abrufenClient-side

Anfrage

Client-Endpunkt. Ruft die tägliche Belohnung des aktuellen Nutzers anhand der Belohnungs-ID ab.

Sicherheit
XsollaLoginUserJWT
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 \
  https://store.xsolla.com/api/v2/project/44056/user/daily_chain/101 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Die tägliche Belohnung des Nutzers wurde 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"
descriptionstring or null

Beschreibung der täglichen Belohnung.

Beispiel: "Major weekly quest"
idinteger

ID der täglichen Belohnung.

Beispiel: 9
namestring

Name der täglichen Belohnung.

Beispiel: "Weekly quest"
orderinteger(order)

Definiert die Anordnungsreihenfolge.

Beispiel: 1
stepsArray of objects(client-daily-chain-step-model)
Antwort
application/json
{
  "date_end": "2025-04-03T18:16:00+05:00",
  "date_start": "2025-04-01T18:16:00+05:00",
  "description": "Active daily reward description",
  "id": 101,
  "name": "Active daily reward",
  "order": 1,
  "steps": [
    { … },
    { … },
    { … },
    { … }
  ],
  "type": "calendar_hard"
}

Täglichen Belohnungsschritt beanspruchenClient-side

Anfrage

Client-Endpunkt. Beansprucht die Schrittbelohnung aus einer täglichen Belohnung für den aktuellen Nutzer. Alle Schritte können nur in fortlaufender Reihenfolge beansprucht werden. Die Belohnung für einen verpassten Schritt kann nicht gegen virtuelle oder reale Währung oder durch das Ansehen einer Werbeanzeige erlangt werden.

Sicherheit
XsollaLoginUserJWT
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
step_numberintegererforderlich

Belohnungsschrittzahl.

Beispiel: 1
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/user/daily_chain/101/step/number/1/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Schrittbelohnung des täglichen Belohnungsschritt wurde erfolgreich für den aktuellen Nutzer beansprucht.

Antwort
Kein Inhalt

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen