Description du point de valeur.
- Lire le solde de points de valeur de l'utilisateur actuel
Lire les chaînes de récompenses de l'utilisateur actuel
Réclamer la récompense d'une étape
Lire le solde de points d...
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/
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
Requête
Endpoint client. Récupère des informations sur les chaînes de récompenses de l'utilisateur actuel.
Attention
Tous les projets sont soumis à une limite de nombre d'objets que vous pouvez obtenir dans la réponse. La valeur par défaut et la valeur maximale sont de 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
Tous les projets sont soumis à une limite de nombre d'objets que vous pouvez obtenir dans la réponse. La valeur par défaut et la valeur maximale sont de 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
Sécurité
XsollaLoginUserJWT
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}/user/reward_chain
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/liveops/v2/project/{project_id}/user/reward_chain
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/user/reward_chain?limit=50&offset=0' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Réponse
application/json
{ "has_more": false, "items": [ { … }, { … } ], "total_items_count": 1 }
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}/user/reward_chain/{reward_chain_id}/balance
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/liveops/v2/project/{project_id}/user/reward_chain/{reward_chain_id}/balance
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://store.xsolla.com/api/v2/project/44056/user/reward_chain/101/balance \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Réponse
application/json
{ "amount": 80, "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "long_description": "Value points given to clans to get new rewards in a reward chain.", "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" }
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}/user/reward_chain/{reward_chain_id}/step/{step_id}/claim
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/liveops/v2/project/{project_id}/user/reward_chain/{reward_chain_id}/step/{step_id}/claim
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://store.xsolla.com/api/v2/project/44056/user/reward_chain/101/step/120/claim \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Récompense de l'utilisateur actuel pour l'étape de la chaîne de récompenses réclamée avec succès.
Réponse
Aucun contenu