Zum Inhalt springen

Ü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
Sprachen
Server
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/de/api/liveops/
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
Operationen
Operationen
Operationen
Operationen

Top-10-Liste der Personen abrufen, die am meisten zur Clan-Belohnungskette beigetragen habenClient-side

Anfrage

Ruft die Top-10-Liste der Personen ab, die am meisten zur angegebenen Belohnungskette des Clans des aktuellen Nutzers beigetragen haben. Wenn ein Nutzer keinem Clan angehört, gibt der Aufruf ein leeres Array zurück.

Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

Projekt-ID.

Beispiel: 44056
reward_chain_idintegererforderlich

Belohnungsketten-ID.

Beispiel: 101
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/user/clan/contributors/101/top \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Die Top-10-Liste der Personen, die am meisten zur Clan-Belohnungskette beigetragen haben.

Bodyapplication/jsonArray [
contributed_amountinteger

Die Anzahl der vom Nutzer beigesteuerten Wertpunkte.

Beispiel: 100
namestring

Benutzer-ID. Die ID, die während der Autorisierung an Xsolla gesendet wird und über die der Nutzer Ihrem Xsolla-Login-Projekt zugeordnet ist.

Beispiel: "Rocket"
]
Antwort
application/json
[ { "contributed_amount": 555, "name": "winner" }, { "contributed_amount": 398, "name": "Rocket" }, { "contributed_amount": 201, "name": "MrJoe" }, { "contributed_amount": 1, "name": "beginner" } ]

Den Clan des aktuellen Nutzers aktualisierenClient-side

Anfrage

Aktualisiert den Clan eines aktuellen Nutzers über Benutzerattribute. Sichert alle Belohnungen aus Belohnungsketten, solange diese nicht für einen vorherigen Clan gesichert wurden, und gibt sie in der Antwort zurück. Wenn der Nutzer früher einem Clan angehörte und jetzt nicht mehr, wird seine Zugehörigkeit zu diesem Clan widerrufen. Wenn der Nutzer den Clan gewechselt hat, wird der Clan geändert.

Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

Projekt-ID.

Standard 44056
curl -i -X PUT \
  'https://store.xsolla.com/api/v2/project/{project_id}/user/clan/update' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Der Clan des Nutzers wurde erfolgreich aktualisiert.

Bodyapplication/json
rewardArray of objects
Antwort
application/json
{ "reward": [ {}, {} ] }
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen