UGS du point de valeur.
- Lire une liste de chaînes de récompenses
Lire la liste des points de valeur
Créer un point de valeur
Supprimer des points de valeur
Lire un point de valeur
Mettre à jour un point de valeur
Supprimer les points de valeur des objets
Lire la liste des objets ayant des points de valeur
Mettre à jour partiellement les points de valeur des objets
Définir des points de valeur pour les objets
Créer une chaîne de récompenses
Supprimer une chaîne de récompenses
Lire une chaîne de récompenses
Mettre à jour une chaîne de récompenses
Réinitialiser la chaîne de récompenses
Basculer une chaîne de récompenses
Lire une liste de chaînes...
Shop Builder API (2.0.0)
- 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/
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
Requête
Attribue des points de valeur à un ou plusieurs objets par UGS. Les utilisateurs reçoivent des points de valeur en achetant ces objets.
Notez que cette requête PUT écrase tous les points de valeur précédemment définis pour les objets du projet.
Pour éviter la suppression involontaire de points de valeur, incluez tous les objets et leurs points de valeur respectifs dans chaque requête PUT.
Si vous souhaitez uniquement mettre à jour les points de valeur d'un objet spécifique tout en préservant les points de valeur des autres objets, vous devez récupérer l'ensemble actuel des points de valeur à l'aide d'une requête GET, modifier les points de valeur de l'objet souhaité, puis renvoyer l'ensemble modifié des points de valeur avec les points de valeur mis à jour pour l'objet spécifique.
Sécurité
basicAuth
Chemin
Corpsapplication/jsonArray [ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas.
Exemple: "booster_mega_1"
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/{value_point_sku}/value_points/rewards
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
-H 'Content-Type: application/json' \
-d '[
{
"amount": 100,
"sku": "com.xsolla.booster_1"
},
{
"amount": 200,
"sku": "com.xsolla.booster_mega"
}
]'Réponse
Aucun contenuRequête
Récupère une liste de chaînes de récompenses.
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 10 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
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 10 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
Sécurité
basicAuth
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/{project_id}/admin/reward_chain
- https://store.xsolla.com/api/v3/project/{project_id}/admin/reward_chain
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/44056/admin/reward_chain?limit=50&offset=0&enabled=0'Réponse
application/json
{ "has_more": true, "items": [ { … }, { … } ] }
Chemin
Corpsapplication/jsonID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
One of:
Chaîne de récompenses.
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(chain_user-attribute_conditions_model-post)[ 1 .. 100 ] items
Conditions de validation des attributs utilisateur. Déterminez la disponibilité de la chaîne selon la correspondance des attributs utilisateur avec l'ensemble des conditions définies.
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)
Conteneur objet contenant les localisations de la description de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme en) et les codes régionaux à cinq caractères (comme en-US). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, en et en-US), seule la dernière est conservée. Consultez la documentation pour la liste complète des langues prises en charge.
One of:
Conteneur objet contenant les localisations de la description de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme en) et les codes régionaux à cinq caractères (comme en-US). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, en et en-US), seule la dernière est conservée. Consultez la documentation pour la liste complète des langues prises en charge.
Détermine la visibilité de la chaîne pour tous les utilisateurs :
- Si
true, la chaîne s'affiche toujours, indépendamment du statut d'authentification ou des attributs de l'utilisateur. - Si
false, la chaîne s'affiche uniquement si aucune chaîne personnalisée ne correspond ; par exemple, si l'utilisateur n'est pas authentifié ou si ses attributs ne correspondent à aucune chaîne personnalisée.
S'applique seulement dans le cadre des chaînes personnalisées et uniquement si le tableau attribute_conditions n'est pas passé.
Par défaut true
Exemple: true
S'il faut réinitialiser la chaîne de récompenses (points de valeur et progression de tous les utilisateurs) après sa date de fin :
- Si
true, la chaîne de récompenses sera réinitialisée après sa date de fin. - Si
false, la chaîne de récompenses ne sera pas réinitialisée après sa date de fin.
Avis
Ne peut pas être
Ne peut pas être
true si : - Une période de réinitialisation est définie dans
recurrent_schedule. - La valeur
nullest passée dansperiods.date_until.
Par défaut false
Exemple: false
long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)
Conteneur objet contenant les localisations de la description complète de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme en) et les codes régionaux à cinq caractères (comme en-US). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, en et en-US), seule la dernière est conservée. Consultez la documentation pour la liste complète des langues prises en charge.
Any of:
Conteneur objet contenant les localisations de la description complète de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme en) et les codes régionaux à cinq caractères (comme en-US). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, en et en-US), seule la dernière est conservée. Consultez la documentation pour la liste complète des langues prises en charge.
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)obligatoire
Conteneur objet contenant les localisations du nom de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme en) et les codes régionaux à cinq caractères (comme en-US). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, en et en-US), seule la dernière est conservée. Consultez la documentation pour la liste complète des langues prises en charge.
One of:
Conteneur objet contenant les localisations du nom de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme en) et les codes régionaux à cinq caractères (comme en-US). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, en et en-US), seule la dernière est conservée. Consultez la documentation pour la liste complète des langues prises en charge.
Périodes de validité de la chaîne de récompenses. Si plusieurs périodes sont spécifiées, les paramètres date_from et date_until sont tous deux requis.
Date de début de la chaîne de récompenses spécifiée.
Exemple: "2020-08-11T10:00:00+03:00"
recurrent_schedule(interval_type = weekly (object or null)) or (interval_type = monthly (object or null)) or (interval_type = horaire (object or null))(recurrent_schedule_create_update)
Période de réinitialisation récurrente de la chaîne de récompenses.
One of:
Période de réinitialisation récurrente de la chaîne de récompenses.
steps[].name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)obligatoire
Conteneur objet contenant les localisations du nom de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme en) et les codes régionaux à cinq caractères (comme en-US). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, en et en-US), seule la dernière est conservée. Consultez la documentation pour la liste complète des langues prises en charge.
One of:
Conteneur objet contenant les localisations du nom de l'objet (item). Il accepte deux formats de codes de langue : les codes à deux lettres minuscules (comme en) et les codes régionaux à cinq caractères (comme en-US). Les deux formats sont valides en entrée, mais les réponses utilisent toujours le format à deux lettres. Si les deux variantes sont fournies pour une même langue (par exemple, en et en-US), seule la dernière est conservée. Consultez la documentation pour la liste complète des langues prises en charge.
steps[].reward[].attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(reward-chain-step-reward_user-attribute_conditions_model-post)[ 1 .. 100 ] items
Conditions de validation des attributs utilisateur. Déterminez la disponibilité de la récompense pour les étapes de la chaîne de récompenses selon la correspondance des attributs utilisateur avec l'ensemble des conditions définies.
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/{project_id}/admin/reward_chain
- https://store.xsolla.com/api/v3/project/{project_id}/admin/reward_chain
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://xsolla.redocly.app/_mock/fr/api/shop-builder/v3/project/44056/admin/reward_chain \
-H 'Content-Type: application/json' \
-d '{
"clan_type": "guild",
"description": {
"en": "Clan reward chain description."
},
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"is_enabled": true,
"long_description": {
"en": "Clan reward chain long description."
},
"name": {
"en": "Clan reward chain"
},
"order": 1,
"periods": [
{
"date_from": "2026-01-01T01:00:00+05:00",
"date_until": "2026-01-31T23:59:59+05:00"
},
{
"date_from": "2026-02-01T01:00:00+05:00",
"date_until": "2026-02-28T23:59:59+05:00"
}
],
"popup_header": {
"en": "How to unlock rewards"
},
"popup_image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"popup_instruction": {
"en": "You must be a clan member to get clan rewards. You join a clan when a clan member invites you to the clan, and you accept the invite. You can also create your own clan."
},
"recurrent_schedule": {
"day_of_week": 1,
"interval_type": "weekly",
"time": "01:00:00+08:00"
},
"steps": [
{
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {
"en": "First step of the reward chain"
},
"price": {
"amount": 10
},
"reward": [
{
"quantity": 5,
"sku": "com.xsolla.item_1"
},
{
"quantity": 1,
"sku": "com.xsolla.item_2"
}
]
},
{
"image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png",
"name": {
"en": "Second step of the reward chain"
},
"price": {
"amount": 15
},
"reward": [
{
"quantity": 5,
"sku": "com.xsolla.item_3"
},
{
"quantity": 1,
"sku": "com.xsolla.item_4"
}
]
}
],
"value_point": {
"sku": "com.xsolla.clan_value_point_1"
}
}'Réponse
application/json
{ "reward_chain_id": 10 }