Passer au contenu
/
Supprimer une promotion p...

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

Créer une promotion par bonusServer-sideAdmin

Requête

Crée une promotion par bonus.

La promotion ajoute des objets bonus gratuits à l'achat effectué par l'utilisateur. La promotion peut être appliquée à chaque achat au sein d'un projet ou à un achat comprenant des objets particuliers.

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
Corpsapplication/json
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.

bonusArray of objects or nullobligatoire
bonus[].​quantitynumber

Quantité de l'objet.

Par défaut 1
bonus[].​skustring

UGS de l'objet.

Par défaut "elven_shield"
conditionArray of objects or nullobligatoire

Ensemble d'objets devant être inclus dans l'achat pour l'application d'une promotion. Si ce paramètre est défini sur null, la promotion s'applique à tous les achats effectués dans au sein du projet.

condition[].​skustring

UGS de l'objet.

Par défaut "elven_sword"
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.

is_enabledboolean(Promotions_is_enabled)

Si la promotion est activée ou non.

Exemple: true
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: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
name.​property name*stringpropriété supplémentaire
price_conditionsArray of objects or null(price_conditions_bonus)

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 condition 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 POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/promotion/bonus \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "bonus": [
      {
        "quantity": 50000,
        "sku": "com.xsolla.mp_credits"
      }
    ],
    "condition": [
      {
        "sku": "com.xsolla.year_1_season_pass"
      }
    ],
    "name": {
      "de-DE": "Neujahrsbonus",
      "en-US": "New Year Bonus"
    },
    "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é créée avec succès.

Corpsapplication/json
promotion_idinteger

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

Réponse
application/json
{
  "promotion_id": 2384756
}

Supprimer une promotion par bonusServer-sideAdmin

Requête

Supprime la promotion par bonus. 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 obtenir d'objets bonus à 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/bonus

Réponses

Promotion supprimée avec succès.

Réponse
Aucun contenu

Lire une promotion par bonusServer-sideAdmin

Requête

Récupère des informations sur une promotion par bonus.

La promotion ajoute des objets bonus gratuits à l'achat effectué par l'utilisateur. La promotion peut être appliquée à chaque achat au sein d'un projet ou à un achat comprenant des objets particuliers.

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/bonus

Réponses

La promotion par bonus a été reçue 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.

bonusArray of objects or null
conditionArray of objects or null

Ensemble d'objets devant être inclus dans l'achat pour l'application d'une promotion. Si ce paramètre est défini sur null, la promotion s'applique à tous les achats effectués dans au sein du projet.

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.

is_enabledboolean
Par défaut true
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: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
price_conditionsArray of objects or null(price_conditions_bonus)

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 condition 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
{
  "bonus": [
    { … },
    { … },
    { … }
  ],
  "condition": [
    { … },
    { … }
  ],
  "excluded_promotions": [
    23,
    45
  ],
  "id": 1,
  "is_enabled": true,
  "limits": {
    "per_item": null,
    "per_user": { … },
    "recurrent_schedule": { … }
  },
  "name": {
    "de-DE": "Neujahrsbonus",
    "en-US": "New Year Bonus"
  },
  "price_conditions": [
    { … },
    { … }
  ],
  "promotion_periods": [
    { … }
  ]
}

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