Passer au contenu
/
Échanger un code de coupo...

Shop Builder API (2.0.0)

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
index.json
index.yaml
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/shop-builder/
https://store.xsolla.com/api/

Administrateur

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

Administrateur

Opérations

Catalogue

Opérations

Panier (côté client)

Opérations

Panier (côté serveur)

Opérations

Paiement (côté client)

Opérations

Paiement (côté serveur)

Opérations

Commande

Opérations

Biens gratuits

Opérations

Webhooks

Opérations

Pré-commandes

Opérations

Commerçant

Opérations

Catalogue

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

Opérations

Régions communes

Opérations

Catalogue

Opérations

Droit

Opérations

Administrateur

Opérations

Communs

Opérations

Coupons

Cette API permet de gérer les coupons.

Opérations

Lire les récompenses d'un couponClient-side

Requête

Récupère les récompenses associées au coupon par son code. Peut être utilisé pour permettre aux utilisateurs de choisir l'un des nombreux objets proposés comme bonus. Le cas habituel est le choix d'un DRM si le coupon contient un jeu comme bonus (type=unit).

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
coupon_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/coupon/code/WINTER2021/rewards \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

La liste des récompenses associées au coupon a été reçue avec succès.

Corpsapplication/json
bonusArray of objects(Promotions_200-coupon-bonus-reward)
discountobject or null(Promotions_200-coupon-discount-reward)

Pourcentage de la remise. Le prix du panier sera réduit d'une valeur calculée à l'aide de ce pourcentage et arrondie à 2 décimales.

is_selectableboolean

Si true, l'utilisateur doit choisir le bonus avant d'échanger un coupon.

Réponse
application/json
{
  "bonus": [
    { … },
    { … }
  ],
  "discount": {
    "percent": "10.00"
  },
  "is_selectable": true
}

Échanger un code de couponClient-side

Requête

Échange un code de coupon. L'utilisateur reçoit un bonus après l'échange.

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
Corpsapplication/json
coupon_codestring[ 1 .. 128 ] characters

Code unique de coupon. Comprend des lettres et des chiffres.

Par défaut "WINTER2021"
Exemple: "WINTER2021"
selected_unit_itemsobject(Promotions_selected_unit_items)

Récompense sélectionnée par l'utilisateur. La clé d'objet est l'UGS d'une unité et la valeur est l'UGS de l'un des objets de l'unité.

Exemple: {"game_1":"game_1_steam","game_2":"game_2_playstation"}
curl -i -X POST \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/coupon/redeem \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021",
    "selected_unit_items": {
      "game_1": "game_1_steam",
      "game_2": "game_2_playstation"
    }
  }'

Réponses

Le coupon a été échangé avec succès.

Corpsapplication/json
itemsArray of objects
Exemple: [{"attributes":[],"description":"Take it, take it all! All of Xsolla's riches in one Mega Booster.","groups":[{"external_id":"powerups","name":"Power Ups"}],"image_url":"https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png","is_free":false,"name":"Xsolla Booster Mega","price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"quantity":1,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[]}]
Réponse
application/json
{
  "items": [
    { … }
  ]
}

Lire la liste des promotions par couponServer-sideAdmin

Requête

Récupère la liste des promotions par coupon 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
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/44056/admin/coupon?limit=50&offset=0'

Réponses

La liste des coupons 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.

itemsArray of objects(admin-promotions_200-get-coupon-promotion-model)
total_promotions_countinteger(total_promotions_count)

Nombre total de promotions.

Réponse
application/json
{
  "active_promotions_count": 2,
  "inactive_promotions_count": 0,
  "items": [
    { … },
    { … }
  ],
  "total_promotions_count": 2
}

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

Administrateur

Opérations

Catalogue

Opérations

Paiement virtuel

Opérations

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

Administrateur

Opérations