Prozentualer Rabatt. Der Preis des Warenkorbs wird um einen Wert verringert, der anhand dieses Prozentsatzes berechnet und dann auf zwei Dezimalstellen gerundet wird.
- Gutscheincode einlösen
Limits eindeutiger Gutscheincodes abrufen
Gutscheinaktion aktivieren
Gutscheincodes abrufen
Gutscheincode erstellen
Gutscheincodes generieren
Gutscheinaktion deaktivieren
Gutschein-Limit für den angegebenen Benutzer abrufen
Gutscheinbelohnung abrufen
Liste der Gutscheinaktionen abrufen
Gutscheinaktionen erstellen
Gutscheinaktion löschen
Gutscheinaktion abrufen
Gutscheinaktion aktualisieren
Gutscheincode einlösen
LiveOps API (2.0.0)
- 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.
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/
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/coupon/code/{coupon_code}/rewards
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/liveops/v2/project/{project_id}/coupon/code/{coupon_code}/rewards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://store.xsolla.com/api/v2/project/44056/coupon/code/WINTER2021/rewards \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Antwort
application/json
{ "bonus": [ { … }, { … } ], "discount": { "percent": "10.00" }, "is_selectable": true }
Pfad
Bodyapplication/jsonProjekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Eindeutiger Gutscheincode. Enthält Buchstaben und Ziffern.
Standard "WINTER2021"
Beispiel: "WINTER2021"
- https://store.xsolla.com/api/v2/project/{project_id}/coupon/redeem
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/liveops/v2/project/{project_id}/coupon/redeem
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://store.xsolla.com/api/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"
}
}'Gutschein wurde erfolgreich eingelöst.
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": [ { … } ] }
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
- https://store.xsolla.com/api/v3/project/{project_id}/admin/coupon
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/liveops/v3/project/{project_id}/admin/coupon
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v3/project/44056/admin/coupon?limit=50&offset=0'Antwort
application/json
{ "active_promotions_count": 2, "inactive_promotions_count": 0, "items": [ { … }, { … } ], "total_promotions_count": 2 }
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