Zum Inhalt springen
/
Wertpunkte für Artikel fe...

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

Wertpunkte für Artikel teilweise aktualisierenServer-sideAdmin

Anfrage

Aktualisiert die Anzahl der Wertpunkte für einen oder mehrere Artikel teilweise anhand der SKU des Artikels. Nutzer erhalten Wertpunkte nach dem Kauf der angegebenen Artikel.

Grundregeln für die Aktualisierung von Wertpunkten:

  • Wenn einem Artikel noch keine Wertpunkte zugewiesen sind, werden diese durch das Senden eines Wertes ungleich Null in das Feld amount eingetragen.
  • Wenn einem Artikel bereits Wertpunkte zugewiesen sind, werden die im Feld amount angegebenen Wertpunkte durch das Senden eines Wertes ungleich Null überschrieben.
  • Wennamount auf 0 festgelgt wird, werden die vorhandenen Wertpunkte für diesen Artikel gelöscht.

Im Gegensatz zur PUT-Methode (Wertpunkte für Artikel festlegen), werden bei dieser PATCH-Methode nicht alle vorhandenen Artikel-Wertpunkte im Projekt überschrieben, sondern nur die Wertpunkte der angegebenen Artikel aktualisiert.

Mit einer einzelnen Anfrage können bis zu 100 Artikel aktualisiert werden. Doppelt vorhandene Artikel-SKUs dürfen nicht in derselben Anfrage enthalten sein.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
value_point_skustringerforderlich

Wertepunkt-SKU.

Beispiel: value_point_3
Bodyapplication/jsonArray [
amountinteger>= 0erforderlich

Anzahl der Wertpunkte.

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"
]
curl -i -X PATCH \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "booster_1"
    },
    {
      "amount": 0,
      "sku": "booster_mega"
    }
  ]'

Antworten

Wertpunktbelohnungen für Artikel wurden erfolgreich aktualisiert.

Body
Antwort
Kein Inhalt

Wertpunkte für Artikel festlegenServer-sideAdmin

Anfrage

Weist einem oder mehreren Artikeln durch Angabe der entsprechenden SKU Wertpunkte zu. Nutzer erhalten Wertpunkte, nachdem sie diese Artikel gekauft haben.

Beachten Sie, dass diese PUT-Anfrage alle zuvor festgelegten Wertpunkte für Artikel im Projekt überschreibt.

Um ein unbeabsichtigtes Löschen von Wertpunkten zu vermeiden, müssen alle Artikel und ihre jeweiligen Wertpunkte in jeder PUT-Anfrage angegeben sein.

Wenn Sie nur die Wertpunkte für einen bestimmten Artikel aktualisieren und die Wertpunkte anderer Artikel unverändert lassen möchten, sollten Sie den aktuellen Satz Wertpunkte mithilfe einer GET-Anfrage abrufen, die Wertpunkte des gewünschten Artikels ändern und dann den geänderten Satz mit den aktualisierten Wertpunkten für den entsprechenden Artikel zurücksenden.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

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

Beispiel: 44056
value_point_skustringerforderlich

Wertepunkt-SKU.

Beispiel: value_point_3
Bodyapplication/jsonArray [
amountintegererforderlich

Anzahl der Wertpunkte.

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"
]
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "com.xsolla.booster_1"
    },
    {
      "amount": 200,
      "sku": "com.xsolla.booster_mega"
    }
  ]'

Antworten

Wertpunktbelohnungen für Artikel wurden erfolgreich aktualisiert.

Body
Antwort
Kein Inhalt

Liste der Belohnungsketten abrufenServer-sideAdmin

Anfrage

Ruft die Liste der Belohnungsketten ab.

Achtung

Bei allen Projekten ist die Anzahl der Artikel begrenzt, die Sie in der Antwort erhalten können. Der Standard- und Höchstwert beträgt 10 Artikel pro Antwort. Um pro Seite mehr Daten zu erhalten, verwenden Sie die Felder limit und offset.
Sicherheit
basicAuth
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
enabledinteger

Elemente nach is_enabled-Flag filtern.

curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v3/project/44056/admin/reward_chain?limit=50&offset=0&enabled=0'

Antworten

Die Liste der Belohnungsketten wurde erfolgreich empfangen.

Bodyapplication/json
has_moreboolean(Pagination_has-more)

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

Beispiel: true
itemsArray of admin-get-reward-chain-item-basic-model (object) or admin-get-reward-chain-item-clan-basic-model (object)
Antwort
application/json
{
  "has_more": true,
  "items": [
    { … },
    { … }
  ]
}

Client

Operationen

Clans-Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen