Passer au contenu

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

Télécharger la description d'OpenAPI
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/shop-builder/
https://store.xsolla.com/api/
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
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations

Catalogue

Cette API permet de récupérer tout type d'objet vendable ou tout objet spécifique.

Opérations
Opérations
Opérations
Opérations
Opérations
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
Opérations
Opérations
Opérations
Opérations
Opérations

Lire la liste des objets ayant des points de valeurServer-sideAdmin

Requête

Récupère la liste de tous les objets ayant des points de valeur au sein d'un projet à des fins d'administration.

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
value_point_skustringobligatoire

UGS du point de valeur.

Exemple: value_point_3
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards

Réponses

La liste des objets avec des récompenses en points de valeur a été reçue avec succès.

Corpsapplication/json
itemsArray of objects(admin-item-value-point-reward)
Réponse
application/json
{ "items": [ {}, {} ] }

Mettre à jour partiellement les points de valeur des objetsServer-sideAdmin

Requête

Met à jour partiellement le nombre de points de valeur pour un ou plusieurs objets par UGS. Les utilisateurs reçoivent ces points de valeur après l'achat des objets spécifiés.

Principes de mise à jour des points de valeur :

  • Si un objet ne possède pas encore de points de valeur, l'envoi d'une valeur non nulle dans le champ amounten crée.
  • Si un objet possède déjà des points de valeur, l'envoi d'une valeur non nulle dans le champ amount les met à jour.
  • Si le champ amount est fixé à 0, les points de valeur existants pour cet objet sont supprimés.

Contrairement à la méthode PUT (Définir des points de valeur pour les objets), cette méthode PATCH n'écrase pas tous les points de valeur existants du projet, elle met uniquement à jour les objets spécifiés.

Une seule requête peut mettre à jour jusqu'à 100 objets. Les UGS en double ne sont pas autorisés dans la même requête.

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
value_point_skustringobligatoire

UGS du point de valeur.

Exemple: value_point_3
Corpsapplication/jsonArray [
amountinteger>= 0obligatoire

Montant des points de valeur.

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$obligatoire

ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas.

Exemple: "booster_mega_1"
]
curl -i -X PATCH \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "booster_1"
    },
    {
      "amount": 0,
      "sku": "booster_mega"
    }
  ]'

Réponses

Les récompenses en points de valeur des objets ont été mises à jour avec succès.

Corps
Réponse
Aucun contenu

Définir des points de valeur pour les objetsServer-sideAdmin

Requête

Attribue des points de valeur à un ou plusieurs objets par UGS. Les utilisateurs reçoivent des points de valeur en achetant ces objets.

Notez que cette requête PUT écrase tous les points de valeur précédemment définis pour les objets du projet.

Pour éviter la suppression involontaire de points de valeur, incluez tous les objets et leurs points de valeur respectifs dans chaque requête PUT.

Si vous souhaitez uniquement mettre à jour les points de valeur d'un objet spécifique tout en préservant les points de valeur des autres objets, vous devez récupérer l'ensemble actuel des points de valeur à l'aide d'une requête GET, modifier les points de valeur de l'objet souhaité, puis renvoyer l'ensemble modifié des points de valeur avec les points de valeur mis à jour pour l'objet 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
value_point_skustringobligatoire

UGS du point de valeur.

Exemple: value_point_3
Corpsapplication/jsonArray [
amountintegerobligatoire

Montant des points de valeur.

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$obligatoire

ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas.

Exemple: "booster_mega_1"
]
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "com.xsolla.booster_1"
    },
    {
      "amount": 200,
      "sku": "com.xsolla.booster_mega"
    }
  ]'

Réponses

Les récompenses en points de valeur des objets ont été mises à jour avec succès.

Corps
Réponse
Aucun contenu
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations