Passer au contenu
/
Lire une promotion sur le...

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

Supprimer une promotion sur les objetsServer-sideAdmin

Requête

Supprime la promotion par réduction. Les conséquences suivantes s'en suivent :

  • La promotion disparaît de la liste des promotions configurées dans votre projet ;
  • Elle n'est plus appliquée au catalogue des objets ni au panier. L'utilisateur ne peut plus acheter d'objets à travers cette promotion.

Après la suppression, la promotion ne peut pas être restaurée.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

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

Exemple: 44056
promotion_idintegerobligatoire

ID de la promotion. Identifiant unique de la promotion au sein du projet.

Exemple: 111425
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/item

Réponses

Promotion supprimée avec succès.

Réponse
Aucun contenu

Lire une promotion sur les objetsServer-sideAdmin

Requête

Récupère des informations sur les promotions qui s'appliquent à des objets spécifiques.

Les promotions offrent une remise (%) sur des objets. La remise s'applique à tous les prix des objets spécifiés.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

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

Exemple: 44056
promotion_idintegerobligatoire

ID de la promotion. Identifiant unique de la promotion au sein du projet.

Exemple: 111425
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/item

Réponses

La promotion sur les objets a été reçu avec succès.

Corpsapplication/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items

Conditions de validation des attributs utilisateur. Déterminez la disponibilité de la promotion selon la correspondance des attributs utilisateur avec l'ensemble des conditions définies.

discountobject
Exemple: {"percent":"15.00"}
excluded_promotionsArray of integers(excluded_promotions)

Liste des ID de promotion à exclure lors de l'application de cette promotion.
Example: [12, 789]

Exemple: [12,789]
idinteger

ID de la promotion. Identifiant unique de la promotion au sein du projet.

Exemple: 1
is_enabledboolean(Promotions_is_enabled)

Si la promotion est activée ou non.

Exemple: true
itemsArray of objects or null
Exemple: [{"sku":"com.xsolla.elven_sword_1"},{"sku":"com.xsolla.elven_helmet_1"},{"sku":"com.xsolla.elven_armor_1"}]
limitsobject(Promotions_promotion_limits_response)

Limites de la promotion.

nameobject

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.

Exemple: {"en-US":"Promotion","ru-RU":"Акция"}
price_conditionsArray of objects or null(price_conditions_discount)

Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion.
La promotion ne s'applique qu'aux biens dont le prix répond à toutes les conditions du tableau. Si vous passez ce tableau, définissez la valeur de l'objet items sur null.

promotion_periodsArray of objects(promotion_periods)

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.

Réponse
application/json
{
  "discount": {
    "percent": "20.00"
  },
  "excluded_promotions": [
    23,
    45
  ],
  "id": 1,
  "is_enabled": true,
  "items": [
    { … },
    { … }
  ],
  "limits": {
    "per_item": null,
    "per_user": { … },
    "recurrent_schedule": { … }
  },
  "name": {
    "en-US": "Promotion",
    "ru-RU": "Акция"
  },
  "price_conditions": [
    { … },
    { … }
  ],
  "promotion_periods": [
    { … }
  ]
}

Mettre à jour une promotion sur les objetsServer-sideAdmin

Requête

Met à jour la promotion.

Note

Les nouvelles données remplaceront les anciennes. Si vous souhaitez mettre à jour une promotion partiellement, assurez-vous de passer toutes les données requises dans la requête.

Les promotions offrent une remise (%) sur les objets. La remise s'applique à tous les prix des objets spécifiés.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

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

Exemple: 44056
promotion_idintegerobligatoire

ID de la promotion. Identifiant unique de la promotion au sein du projet.

Exemple: 111425
Corpsapplication/jsonobligatoire

Objet contenant des données de la promotion.

attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items

Conditions de validation des attributs utilisateur. Déterminez la disponibilité de la promotion selon la correspondance des attributs utilisateur avec l'ensemble des conditions définies.

discountobjectobligatoire
discount.​percentstringobligatoire

Pourcentage de la remise. Le prix de l'objet sera réduit d'une valeur calculée à l'aide de ce pourcentage et arrondie à 2 décimales.

Exemple: 10
excluded_promotionsArray of integers(excluded_promotions)

Liste des ID de promotion à exclure lors de l'application de cette promotion.
Example: [12, 789]

Exemple: [12,789]
is_enabledboolean(Promotions_is_enabled)

Si la promotion est activée ou non.

Exemple: true
itemsArray of objectsobligatoire
items[].​skustringobligatoire

UGS de l'objet.

Par défaut "elven_sword"
limitsobject(Promotions_promotion_limits)

Limites de la promotion.

nameobjectobligatoire

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.

Exemple: {"en-US":"Promotion","ru-RU":"Акция"}
name.​property name*stringpropriété supplémentaire
price_conditionsArray of objects or null(price_conditions_discount)

Tableau d'objets avec des conditions définissant la fourchette de prix pour l'application de la promotion.
La promotion ne s'applique qu'aux biens dont le prix répond à toutes les conditions du tableau. Si vous passez ce tableau, définissez la valeur de l'objet items sur null.

promotion_periodsArray of objects(promotion_periods)

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.

curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/111425/item \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "operator": "eq",
        "type": "string",
        "value": "ork"
      },
      {
        "attribute": "level",
        "can_be_missing": true,
        "operator": "eq",
        "type": "number",
        "value": "10"
      }
    ],
    "discount": {
      "percent": "24.00"
    },
    "is_enabled": true,
    "items": [],
    "name": {
      "en-US": "Ork set discount",
      "ru-RU": "Скидка на набор для орка"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

Réponses

La promotion a été mise à jour avec succès.

Réponse
Aucun contenu

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

Administrateur

Opérations

Client

Opérations