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

Lire les chaînes de récompenses de l'utilisateur actuelClient-side

Requête

Endpoint client. Récupère des informations sur les chaînes de récompenses de l'utilisateur actuel.

Attention

Tous les projets sont soumis à une limite de nombre d'objets que vous pouvez obtenir dans la réponse. La valeur par défaut et la valeur maximale sont de 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
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
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 \
  'https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/user/reward_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

La chaîne de récompenses de l'utilisateur a été récupérée avec succès.

Corpsapplication/json
has_moreboolean

Utilisé pour indiquer qu'il y a plus de pages.

Exemple: true
itemsArray of objects(client-reward-chain-item-model)
total_items_countinteger

Nombre total de chaînes de récompenses dans le système.

Exemple: 10
Réponse
application/json
{ "has_more": false, "items": [ {}, {} ], "total_items_count": 1 }

Lire le solde de points de valeur de l'utilisateur actuelClient-side

Requête

Endpoint client. Récupère le solde de points de valeur de l'utilisateur actuel.

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
reward_chain_idintegerobligatoire

ID de la chaîne de récompenses.

Exemple: 101
curl -i -X GET \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/user/reward_chain/101/balance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

Le solde de points de valeur de l'utilisateur a été récupéré avec succès.

Corpsapplication/json
amountinteger

Quantité de points de valeur.

descriptionstring or null(value-point-description)

Description du point de valeur.

image_urlstring(Common_admin-image_url)

URL de l'image.

Exemple: "https://image.example.com"
is_clanboolean(is_clan)

Détermine l'utilisation du point de valeur dans les chaînes de récompense de clan.

Exemple: true
long_descriptionstring or null(value-point-long-description)

Description détaillée du point de valeur.

namestring(value-point-name)

Nom du point de valeur.

skustring(value-point-sku)

ID unique du point de valeur.

Réponse
application/json
{ "amount": 80, "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "long_description": "Value points given to clans to get new rewards in a reward chain.", "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" }

Réclamer la récompense d'une étapeClient-side

Requête

Endpoint client. Réclame la récompense de l'utilisateur actuel pour l'étape de la chaîne de récompenses.

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
reward_chain_idintegerobligatoire

ID de la chaîne de récompenses.

Exemple: 101
step_idintegerobligatoire

ID de l'étape de la chaîne de récompenses.

Exemple: 120
curl -i -X POST \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/user/reward_chain/101/step/120/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

Récompense de l'utilisateur actuel pour l'étape de la chaîne de récompenses réclamée avec succès.

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