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

Requête

Crée un code de coupon.

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
external_idintegerobligatoire

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

Exemple: coupon_44056_1
Corpsapplication/json
coupon_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Code unique sensible à la casse. Comprend des lettres et des chiffres.

Par défaut "WINTER2021"
Exemple: "WINTER2021"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/coupon/coupon_44056_1/code \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021"
  }'

Réponses

Le code a été créé avec succès.

Corpsapplication/json
codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Code unique sensible à la casse. Comprend des lettres et des chiffres.

Par défaut "WINTER2021"
Exemple: "WINTER2021"
Réponse
application/json
{ "code": "WINTER2021" }

Générer des codes de couponServer-sideAdmin

Requête

Génère des codes de coupon.

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
external_idintegerobligatoire

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

Exemple: coupon_44056_1
Corpsapplication/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]obligatoire
Exemple: 10
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/coupon/coupon_44056_1/code/generate \
  -H 'Content-Type: application/json' \
  -d '{
    "count": 10
  }'

Réponses

Les codes ont été générés avec succès.

Corpsapplication/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]
Exemple: 10
Réponse
application/json
{ "count": 10 }

Désactiver une promotion par couponServer-sideAdmin

Requête

Désactive une promotion par coupon. Par défaut, une promotion par coupon créée est désactivée. Pour permettre l'échange de coupons, vous devez l'activer. Utilisez cet endpoint pour désactiver une promotion par coupon.

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
external_idintegerobligatoire

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

Exemple: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/coupon/coupon_44056_1/deactivate

Réponses

Le coupon a été désactivé avec succès.

Réponse
Aucun contenu

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