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

Définir le nombre d'objets offerts pour un utilisateur spécifiqueServer-sideAdmin

Requête

Définit le nombre d'objets qu'un utilisateur spécifique peut acheter dans la limite appliquée après une augmentation ou une diminution.

L'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :

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
item_skustringobligatoire

UGS de l'objet.

Exemple: booster_mega_1
Corpsapplication/json
availableinteger(User-limit_available_flexible)>= 0obligatoire

Nombre restant d'objets ou d'utilisations de la promotion disponibles pour l'utilisateur dans la limite appliquée.

userobject(User-limit_user)obligatoire
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$obligatoire

External ID de l'utilisateur

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 0,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Réponses

Les limites d'achat pour un utilisateur ont été reçues avec succès.

Corpsapplication/json
per_userobject
Réponse
application/json
{ "per_user": { "available": 9, "total": 10 } }

Actualiser la limite d'achatServer-sideAdmin

Requête

Actualise les limites d'achat pour un objet afin que l'utilisateur puisse l'acheter à nouveau. Si le paramètre user est défini sur null, cet appel actualise ces limites pour tous les utilisateurs.

L'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :

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
item_skustringobligatoire

UGS de l'objet.

Exemple: booster_mega_1
Corpsapplication/json
userobject or null(User-limit_user_flexible)obligatoire
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$

External ID de l'utilisateur

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/user/limit/item/sku/booster_mega_1/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Réponses

La limite a été actualisée avec succès.

Réponse
Aucun contenu

Actualiser toutes les limites de promotion pour un utilisateur spécifiqueServer-sideAdmin

Requête

Actualise toutes les limites de toutes les promotions pour un utilisateur spécifique afin qu'il puisse à nouveau utiliser ces promotions.

L'API des limites utilisateur vous permet de limiter le nombre de fois qu'un utilisateur peut utiliser une promotion. Pour configurer les limites utilisateur, accédez à la section Administrateur du type de promotion souhaité :

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
userobject(User-limit_user)obligatoire
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$obligatoire

External ID de l'utilisateur

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/user/limit/promotion/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Réponses

La limite de la promotion a été actualisée avec succès.

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