Zum Inhalt springen
/
Gutscheincode einlösen

LiveOps 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

LiveOps API bietet Endpunkte zur Förderung des Spieler-Engagements.

OpenAPI-Beschreibung herunterladen
index.json
index.yaml
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/liveops/
https://store.xsolla.com/api/

Allgemeines

Operationen

Gutscheine

Mit dieser API können Sie Gutscheine verwalten.

Operationen

Gutscheinbelohnung abrufenClient-side

Anfrage

Ruft Gutscheinbelohnungen anhand des Codes ab. Dadurch können Nutzer aus mehreren Bonusartikeln wählen. Als Normalfall gilt die Wahl eines DRM-Systems, wenn der Gutschein ein Spiel als Bonus enthält (type=unit).

Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

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

Beispiel: 44056
coupon_codestring[ 1 .. 128 ] characterserforderlich

Eindeutiger Code, es wird zwischen Groß- und Kleinschreibung unterschieden. Enthält Buchstaben und Ziffern.

Beispiel: WINTER2021
curl -i -X GET \
  https://xsolla.redocly.app/_mock/de/api/liveops/v2/project/44056/coupon/code/WINTER2021/rewards \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Antworten

Die Liste der Gutscheinprämien wurde erfolgreich empfangen.

Bodyapplication/json
bonusArray of objects(Promotions_200-coupon-bonus-reward)
discountobject or null(Promotions_200-coupon-discount-reward)

Prozentualer Rabatt. Der Preis des Warenkorbs wird um einen Wert verringert, der anhand dieses Prozentsatzes berechnet und dann auf zwei Dezimalstellen gerundet wird.

is_selectableboolean

Ist true eingestellt, sollte der Nutzer vor dem Einlösen eines Gutscheins den Bonus auswählen.

Antwort
application/json
{
  "bonus": [
    { … },
    { … }
  ],
  "discount": {
    "percent": "10.00"
  },
  "is_selectable": true
}

Gutscheincode einlösenClient-side

Anfrage

Löst einen Gutscheincode ein. Der Nutzer erhält nach dem Einlösen eines Gutscheins einen Bonus.

Sicherheit
XsollaLoginUserJWT
Pfad
project_idintegererforderlich

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

Beispiel: 44056
Bodyapplication/json
coupon_codestring[ 1 .. 128 ] characters

Eindeutiger Gutscheincode. Enthält Buchstaben und Ziffern.

Standard "WINTER2021"
Beispiel: "WINTER2021"
selected_unit_itemsobject(Promotions_selected_unit_items)

Die von einem Nutzer ausgewählte Belohnung. Der Objektschlüssel ist eine SKU einer Einheit und der Wert ist eine SKU eines der Artikel in einer Einheit.

Beispiel: {"game_1":"game_1_steam","game_2":"game_2_playstation"}
curl -i -X POST \
  https://xsolla.redocly.app/_mock/de/api/liveops/v2/project/44056/coupon/redeem \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021",
    "selected_unit_items": {
      "game_1": "game_1_steam",
      "game_2": "game_2_playstation"
    }
  }'

Antworten

Gutschein wurde erfolgreich eingelöst.

Bodyapplication/json
itemsArray of objects
Beispiel: [{"attributes":[],"description":"Take it, take it all! All of Xsolla's riches in one Mega Booster.","groups":[{"external_id":"powerups","name":"Power Ups"}],"image_url":"https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png","is_free":false,"name":"Xsolla Booster Mega","price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"quantity":1,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[]}]
Antwort
application/json
{
  "items": [
    { … }
  ]
}

Liste der Gutscheinaktionen abrufenServer-sideAdmin

Anfrage

Ruft die Liste der Gutscheinaktionen eines Projekts ab.

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
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/liveops/v3/project/44056/admin/coupon?limit=50&offset=0'

Antworten

Gutscheinliste wurde erfolgreich empfangen.

Bodyapplication/json
active_promotions_countinteger(active_promotions_count)

Anzahl der aktiven Werbeaktionen.

inactive_promotions_countinteger(inactive_promotions_count)

Anzahl der deaktivierten Werbeaktionen.

itemsArray of objects(admin-promotions_200-get-coupon-promotion-model)
total_promotions_countinteger(total_promotions_count)

Gesamtzahl der Werbeaktionen.

Antwort
application/json
{
  "active_promotions_count": 2,
  "inactive_promotions_count": 0,
  "items": [
    { … },
    { … }
  ],
  "total_promotions_count": 2
}

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

Verwaltung

Operationen

Client

Operationen

Verwaltung

Operationen

Client

Operationen