Nombre de promotions actives.
- Lire une promotion utilisable par code
Activer une promotion
Désactiver une promotion
Vérifier un code promotionnel
Lire la liste de toutes les promotions
Lire une promotion utilis...
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/
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/v3/project/{project_id}/admin/promotion
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/liveops/v3/project/{project_id}/admin/promotion
- 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/promotion?limit=50&offset=0&enabled=0'Réponse
application/json
{ "active_promotions_count": 3, "inactive_promotions_count": 2, "promotions": [ { … }, { … }, { … }, { … }, { … } ], "total_promotions_count": 5 }
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/v3/project/{project_id}/admin/promotion/redeemable/code/{code}
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/liveops/v3/project/{project_id}/admin/promotion/redeemable/code/{code}
- 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/promotion/redeemable/code/WINTER2021La promotion a été reçue avec succès.
Liste des objets bénéficiant d'une remise grâce à un code promo. Uniquement pour les codes promo.
ID unique de la promotion. Le external_id ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas.
Par défaut "coupon_external_id"
Exemple: "coupon_external_id"
Nom de la promotion. Doit comprendre des paires clé/valeur où la clé est une région au format "^[a-z]{2}-[A-Z]{2}$", la valeur est une chaîne.
Par défaut {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Exemple: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Périodes de validité de la promotion. Si plusieurs périodes sont spécifiées, les paramètres date_from et date_until sont tous deux requis.
Nombre d'échanges par code.
Par défaut 10
Exemple: 10
Limite le nombre total de coupons.
Par défaut 10
Exemple: 10
Limite le nombre total de coupons pouvant être échangés par un seul utilisateur.
Par défaut 10
Exemple: 10
Réponse
application/json
{ "bonus": [ { … } ], "external_id": "coupon_fall_hammer_2", "is_enabled": true, "name": { "en": "This is a Coupon code for Epic Fall Hammer", "ru": "Eto kod kupona на Epic Fall Hammer" }, "promotion_periods": [ { … }, { … } ], "redeem_code_limit": null, "redeem_total_limit": 99, "redeem_user_limit": 1 }
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