Passer au contenu
/
Lire toutes les règles du...

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

Créer une règle de filtrage du catalogueServer-sideAdmin

Requête

Crée une règle pour les attributs utilisateur.

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)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] itemsobligatoire

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

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$obligatoire

Code d'attribut utilisateur.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

Indique que la condition est remplie même si l'attribut est absent des attributs de l'utilisateur. Passez true pour afficher l'objet pour les utilisateurs ne possédant pas cet attribut. Les utilisateurs ayant l'attribut, mais dont la valeur ne correspond pas à celle définie dans la condition ne verront pas l'objet. Si vous passez false, les utilisateurs dont l'attribut est manquant ou dont la valeur ne correspond pas à celle spécifiée dans la condition ne verront pas l'objet.

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)obligatoire

Type d'opération effectuée par la condition. Pour le type d'attribut string.

Enum ValeurDescription
eq

Égal

ne

Différent de

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)obligatoire

Type d'attribut utilisateur.

Valeur"string"
attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 charactersobligatoire

Valeur de la condition à laquelle la valeur de l'attribut utilisateur sera comparée. Le type dépend du type d'attribut.

is_enabledbooleanobligatoire

Si la règle est activée.

is_satisfied_for_unauthboolean

Détermine l'affichage de l'objet aux utilisateurs non autorisés. Si true, l'objet s'affiche à l'utilisateur non autorisé sans tenir compte des règles d'affichage du catalogue. La valeur par défaut est false.

itemsArray of objects[ 1 .. 100 ] itemsobligatoire
One of:

Objets qui sont affichés à l'utilisateur si les valeurs de ses attributs répondent aux conditions.

items[].​item_idnumberobligatoire

ID de l'objet

namestring[ 1 .. 255 ] characters^\Sobligatoire

Nom lisible d'une règle. Utilisé pour afficher une règle dans le Compte éditeur.

curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/attribute/rule \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "ork"
      }
    ],
    "is_enabled": true,
    "is_satisfied_for_unauth": false,
    "items": [
      {
        "item_id": 1
      }
    ],
    "name": "Ork race armor rule"
  }'

Réponses

La règle a été créée avec succès.

Corpsapplication/json
rule_idnumber

ID de règle.

Réponse
application/json
{
  "rule_id": 1
}

Lire toutes les règles du catalogue pour une recherche côté clientServer-sideAdmin

Requête

Récupère une liste de toutes les règles du catalogue pour la recherche côté client.

Attention

Renvoie uniquement l'ID et le nom de la règle et is_enabled
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
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/attribute/rule/all

Réponses

Les règles ont été reçues avec succès.

Corpsapplication/json
itemsArray of objects(user-attribute_personalized-catalog_all)
Réponse
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Supprimer une règle de filtrage du catalogueServer-sideAdmin

Requête

Supprime une règle spécifique.

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
rule_idnumberobligatoire

ID de règle.

Exemple: 1
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/attribute/rule/1

Réponses

La suppression a été effectuée avec succès.

Réponse
Aucun contenu

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