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

Désactiver une promotionServer-sideAdmin

Requête

Désactive une promotion.

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 PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/promotion/111425/deactivate

Réponses

La promotion a été désactivée avec succès.

Réponse
Aucun contenu

Vérifier un code promotionnelClient-side

Requête

Détermine si le code est un code promo ou un code de coupon et si l'utilisateur peut l'appliquer.

Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Exemple: 44056
codestring[ 1 .. 128 ] charactersobligatoire

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

Exemple: WINTER2021
curl -i -X GET \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/promotion/code/WINTER2021/verify \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

Informations sur le code.

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"
rewardsCoupon_rewards (object) or Promo_code_rewards_verify (object)
One of:
typestring

Type de code : promocode/coupon.

Réponse
application/json
{ "code": "WINTER2023", "rewards": { "bonus": [], "is_selectable": true }, "type": "coupon" }

Lire la liste de toutes les promotionsServer-sideAdmin

Requête

Récupère la liste des promotions d'un projet.

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
Requête
limitinteger>= 1

Nombre maximal d'éléments sur une page.

Exemple: limit=50
offsetinteger>= 0

Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).

Exemple: offset=0
enabledinteger

Filtrer les éléments en fonction de l'indicateur is_enabled.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/44056/admin/promotion?limit=50&offset=0&enabled=0'

Réponses

La liste des promotions a été reçue avec succès.

Corpsapplication/json
active_promotions_countinteger(active_promotions_count)

Nombre de promotions actives.

inactive_promotions_countinteger(inactive_promotions_count)

Nombre de promotions désactivées.

promotionsArray of objects(Promotions_200-get-promotion-model)
total_promotions_countinteger(total_promotions_count)

Nombre total de promotions.

Réponse
application/json
{ "active_promotions_count": 3, "inactive_promotions_count": 2, "promotions": [ {}, {}, {}, {}, {} ], "total_promotions_count": 5 }

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