External ID du groupe.
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.
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.
Requête
Récupère une liste d'objets vendables à partir d'un groupe spécifié pour la constitution d'un catalogue.
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 50 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
L'utilisation des appels API du catalogue des objets est disponible sans autorisation, mais pour obtenir un catalogue personnalisé, vous devez passer le JWT utilisateur dans l'en-tête d'autorisation.
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).
Langue de la réponse. Code de langue à deux lettres minuscules selon la norme ISO 639-1.
La liste des champs supplémentaires. Ces champs figureront dans la réponse si vous les envoyez dans votre requête.
Code pays à deux lettres majuscules selon la norme ISO 3166-1 alpha-2. Consultez la documentation pour obtenir des informations détaillées sur les pays pris en charge par Xsolla et le processus de détermination du pays.
Code unique sensible à la casse. Comprend des lettres et des chiffres.
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/{project_id}/items/group/{external_id}
- https://store.xsolla.com/api/v2/project/{project_id}/items/group/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/59080/items/group/{external_id}?limit=50&offset=0&locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'La liste des objets vendables du groupe spécifié a été reçue avec succès.
{ "has_more": true, "items": [ { … }, { … }, { … }, { … } ] }
Requête
Récupère des informations sur un objet vendable par son ID.
Cet endpoint, accessible sans autorisation, renvoie des données génériques. Cependant, l'autorisation enrichit la réponse avec des détails spécifiques à l'utilisateur pour un résultat personnalisé, tels que les limites et les promotions disponibles pour l'utilisateur.
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Code unique sensible à la casse. Comprend des lettres et des chiffres.
Affiche les objets à durée limitée qui ne sont pas disponibles pour l'utilisateur. La période de validité de ces objets n'ayant pas commencé ou ayant déjà expiré.
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/{project_id}/items/id/{item_id}
- https://store.xsolla.com/api/v2/project/{project_id}/items/id/{item_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/59080/items/id/259774?promo_code=WINTER2021&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'L'objet vendable a été reçu avec succès.
Liste des attributs et de leurs valeurs correspondantes pour l'objet. Peut être utilisée pour le filtrage du catalogue.
Un JSON contenant les attributs de l'objet et leurs valeurs.
Groupes auxquels l'objet appartient.
URL de l'image.
Si ce paramètre est défini sur true, l'objet est gratuit.
Promotions appliquées à des objets spécifiques du panier. Le tableau est renvoyé dans les cas suivants :
Une promotion par réduction est configurée pour un objet spécifique.
Un code promo avec le paramètre Discount on selected items est appliqué.
Si aucune promotion de ce type n'est appliquée, un tableau vide est renvoyé.
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.
Type d'objet : virtual_good/virtual_currency/bundle/game_key/physical_good.
Type d'objet virtuel.
| Enum Valeur | Description |
|---|---|
| consumable | Un objet qui disparaît de l'inventaire après utilisation (par exemple, des munitions). |
| non_consumable | Un objet qui reste dans l'inventaire pour une durée illimitée. |
| non_renewing_subscription | Objet à durée limitée qui peut représenter l'accès à des services ou à du contenu pour une période de temps limitée. |
{ "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Electric shield", "groups": [ { … } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "limits": { "per_user": { … } }, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { … } ], "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { … }, { … }, { … } ], "vp_rewards": [ { … }, { … } ] }
Requête
Récupère des informations sur un objet vendable par son UGS pour la constitution d'un catalogue.
Cet endpoint, accessible sans autorisation, renvoie des données génériques. Cependant, l'autorisation enrichit la réponse avec des détails spécifiques à l'utilisateur pour un résultat personnalisé, tels que les limites et les promotions disponibles pour l'utilisateur.
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Code unique sensible à la casse. Comprend des lettres et des chiffres.
Affiche les objets à durée limitée qui ne sont pas disponibles pour l'utilisateur. La période de validité de ces objets n'ayant pas commencé ou ayant déjà expiré.
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/{project_id}/items/sku/{sku}
- https://store.xsolla.com/api/v2/project/{project_id}/items/sku/{sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/59080/items/sku/electric_shield?promo_code=WINTER2021&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'L'objet vendable a été reçu avec succès.
Liste des attributs et de leurs valeurs correspondantes pour l'objet. Peut être utilisée pour le filtrage du catalogue.
Un JSON contenant les attributs de l'objet et leurs valeurs.
Groupes auxquels l'objet appartient.
URL de l'image.
Si ce paramètre est défini sur true, l'objet est gratuit.
Promotions appliquées à des objets spécifiques du panier. Le tableau est renvoyé dans les cas suivants :
Une promotion par réduction est configurée pour un objet spécifique.
Un code promo avec le paramètre Discount on selected items est appliqué.
Si aucune promotion de ce type n'est appliquée, un tableau vide est renvoyé.
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.
Type d'objet : virtual_good/virtual_currency/bundle/game_key/physical_good.
Type d'objet virtuel.
| Enum Valeur | Description |
|---|---|
| consumable | Un objet qui disparaît de l'inventaire après utilisation (par exemple, des munitions). |
| non_consumable | Un objet qui reste dans l'inventaire pour une durée illimitée. |
| non_renewing_subscription | Objet à durée limitée qui peut représenter l'accès à des services ou à du contenu pour une période de temps limitée. |
{ "attributes": [], "can_be_bought": true, "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "Electric shield", "groups": [ { … } ], "image_url": "https://cdn3.xsolla.com/img/misc/images/d2d6b1b517e6a7f3765c3bb5a3cfb87d.png", "is_free": false, "item_id": 259774, "limits": { "per_user": { … } }, "name": "Electric shield", "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [ { … } ], "sku": "com.xsolla.electric_shield_1", "type": "virtual_good", "virtual_item_type": "non_consumable", "virtual_prices": [ { … }, { … }, { … } ], "vp_rewards": [ { … }, { … } ] }