Passer au contenu
/
Réclamer une étape de cha...

LiveOps API (2.0.0)

Aperçu

  • 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.

Appels API

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
index.json
index.yaml
Langues
Serveurs
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/fr/api/liveops/

Communs

Opérations

Coupons

Cette API permet de gérer les coupons.

Opérations

Codes promo

Cette API permet de gérer les codes promo.

Opérations

Offres uniques du catalogue

Cette API permet de gérer les offres uniques du catalogue.

Opérations

Remises

Cette API permet de gérer les promotions par réduction

Opérations

Bonus

Cette API permet de gérer les promotions par bonus.

Opérations

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

Gestion

Opérations

Administrateur

Opérations

Client

Opérations

Client clans

Opérations

Administrateur

Opérations

Client

Opérations

Administrateur

Opérations

Client

Opérations

Lire une chaîne d'offres de l'utilisateur actuel par IDClient-side

Requête

Récupère la chaîne d'offres de l'utilisateur actuel par l'ID de la chaîne d'offres.

Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Exemple: 44056
offer_chain_idintegerobligatoire

ID de la chaîne d'offres.

Exemple: 101
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/user/offer_chain/101 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

Chaîne d'offres de l'utilisateur récupérée avec succès.

Corpsapplication/json
date_endstring or null(date-time)(offer_chain_date_end)

Date de fin de la chaîne d’offres. Peut être null. Si date_end est null, la chaîne d'offres n'a pas de limite de temps.

Exemple: "2020-04-15T18:16:00+05:00"
date_startstring(date-time)(offer_chain_date_start)

Date de début de la chaîne d'offres.

Exemple: "2020-04-15T18:16:00+05:00"
descriptionstring or null

Description de la chaîne d'offres.

Exemple: "Major weekly quest"
idinteger

ID de la chaîne d'offres.

Exemple: 9
namestring

Nom de la chaîne d'offres.

Exemple: "Weekly quest"
next_step_numberinteger or null

Numéro de l'étape suivante de la chaîne d'offres. null si la chaîne d'offres est terminée.

Exemple: 1
orderinteger(order)

Définit l'ordre d'empilement.

Exemple: 1
recurrent_scheduleobject or null(offer_chain_recurrent_schedule_client_side)

Période de réinitialisation de la chaîne d'offres.

stepsArray of objects(client-offer-chain-step-model)
Réponse
application/json
{
  "date_end": "2025-04-25T18:16:00+05:00",
  "date_start": "2010-04-15T18:16:00+05:00",
  "description": null,
  "id": 4,
  "name": "Offer chain with bundles",
  "next_step_number": 1,
  "order": 1,
  "recurrent_schedule": null,
  "steps": [
    { … },
    { … }
  ]
}

Réclamer une étape de chaîne d'offres gratuiteClient-side

Requête

Termine la progression de l'utilisateur actuel dans l'étape de la chaîne d'offres et attribue la récompense associée.

Attention

Utilisez cet appel uniquement pour les étapes gratuites de la chaîne d’offres. Pour les étapes nécessitant un paiement en devises réelles, utilisez plutôt l'appel Créer une commande pour une étape payante de la chaîne d'offres.
Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Exemple: 44056
offer_chain_idintegerobligatoire

ID de la chaîne d'offres.

Exemple: 101
step_numberintegerobligatoire

Numéro de l'étape de la chaîne d'offres.

Exemple: 1
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/user/offer_chain/101/step/number/1/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

Étape gratuite réclamée avec succès et récompense attribuée.

Corpsapplication/json
order_idinteger

ID de commande.

Réponse
application/json
{
  "order_id": 641
}

Créer une commande pour une étape payante de la chaîne d'offresClient-side

Requête

Crée une commande pour l'objet associé à une étape payante spécifique de la chaîne d'offres. La commande créée obtient le statut new.

Pour ouvrir l'interface de paiement dans une nouvelle fenêtre, utilisez le lien suivant : https://secure.xsolla.com/paystation4/?token={token}, où {token} est le jeton reçu.

À des fins de test, utilisez cette URL : https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Attention

Cette méthode doit être utilisée côté client. L'adresse IP de l'utilisateur permet de déterminer son pays, ce qui influence la devise et les modes de paiement disponibles. Utiliser cette méthode côté serveur peut entraîner une détection incorrecte de la devise et affecter les modes de paiement dans Pay Station.

Attention

Utilisez cet appel uniquement pour les étapes payantes de la chaîne d'offres. Pour les étapes gratuites, utilisez plutôt l'appel Réclamer une étape de chaîne d'offres gratuite.
Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Exemple: 44056
offer_chain_idintegerobligatoire

ID de la chaîne d'offres.

Exemple: 101
step_numberintegerobligatoire

Numéro de l'étape de la chaîne d'offres.

Exemple: 1
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/user/offer_chain/101/step/number/1/order \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

La commande a été créée avec succès.

Corpsapplication/json
order_idinteger

ID de commande.

tokenstring

Jeton de paiement.

Réponse
application/json
{
  "order_id": 641,
  "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo"
}

Administrateur

Opérations

Client

Opérations