External ID de la promotion. Identifiant unique de la promotion au sein du projet.
- Lire les récompenses d'un coupon
Lire les limites pour les code de coupon uniques
Activer une promotion par coupon
Lire les codes de coupon
Créer un code de coupon
Générer des codes de coupon
Désactiver une promotion par coupon
Lire la limite de coupon pour un utilisateur spécifique
Échanger un code de coupon
Lire la liste des promotions par coupon
Créer une promotion par coupon
Supprimer une promotion par coupon
Lire une promotion par coupon
Mettre à jour une promotion par coupon
Lire les récompenses d'un...
LiveOps API (2.0.0)
- Version : 2.0.0
- Serveurs :
https://store.xsolla.com/api - Contactez-nous par e-mail
- URL de contact : https://xsolla.com/
- Version TLS requise : 1.2
LiveOps est un ensemble d’outils pour stimuler l’engagement continu des joueurs grâce à des promotions et des offres personnalisées.
Utilisez l’API pour gérer les fonctionnalités suivantes :
- Promotions — créez et gérez des coupons, des codes promo, des réductions et des campagnes bonus.
- Personnalisation — définissez les conditions d’affichage du catalogue des objets et d’application des promotions uniquement pour certains utilisateurs autorisés.
- Limites de promotion — définissez combien de fois un utilisateur peut utiliser une promotion et configurez des réinitialisations planifiées de ces limites.
- Chaînes de récompense et points de valeur — configurez des progressions de récompense liées à l’accumulation de points de valeur.
- Chaînes quotidiennes — mettez en place des récompenses quotidiennes récurrentes pour encourager les connexions régulières.
- **Chaînes d’offres — créez des offres d’achat séquentielles avec tarification par étape et options de récompense gratuite.
- Upsell — méthode de vente proposant à l’utilisateur d’acheter un objet avec une valeur ajoutée.
L’API est divisée en groupes suivants :
Admin — appels pour créer, mettre à jour, activer et supprimer des campagnes et configurations de chaînes. Authentification via l’authentification d’accès de base avec vos identifiants commerçant ou projet.Client — appels pour récupérer les promotions disponibles, obtenir les chaînes actives, échanger des codes et réclamer des récompenses pour les utilisateurs finaux authentifiés. Authentification via JWT utilisateur.
Télécharger la description d'OpenAPI
Langues
Serveurs
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/fr/api/liveops/
Requête
Récupère le nombre restant de fois qu'un utilisateur spécifique peut utiliser le coupon.
L'API des limites utilisateur vous permet de limiter le nombre de fois que les utilisateurs peuvent utiliser un coupon. Pour configurer les limites utilisateur, référez-vous à la section Administrateur :
Sécurité
basicAuth
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/liveops/v2/project/{project_id}/admin/user/limit/coupon/external_id/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v2/project/44056/admin/user/limit/coupon/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'Réponse
application/json
{ "per_user": { "available": 9, "total": 10 } }
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/coupon/code/{coupon_code}/rewards
- Mock serverhttps://xsolla.redocly.app/_mock/fr/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>'Réponse
application/json
{ "bonus": [ { … }, { … } ], "discount": { "percent": "10.00" }, "is_selectable": true }
Chemin
Corpsapplication/jsonID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
Code unique de coupon. Comprend des lettres et des chiffres.
Par défaut "WINTER2021"
Exemple: "WINTER2021"
- https://store.xsolla.com/api/v2/project/{project_id}/coupon/redeem
- Mock serverhttps://xsolla.redocly.app/_mock/fr/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"
}
}'Le coupon a été échangé avec succès.
Exemple: [{"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":[]}]
Réponse
application/json
{ "items": [ { … } ] }
Catalogue personnalisé
Cette API permet de spécifier des règles pour les attributs utilisateur. Si l'utilisateur remplit toutes les conditions d'une règle concrète, des objets personnalisés seront affichés.
Pour les promotions personnalisées, voir la section Promotions.
Pour passer des attributs avant un achat, utilisez Xsolla Login API ou passez-les dans la propriété user.attributes lors de la génération du jeton à l'aide de Pay Station API.
Opérations