External ID du groupe.
- Lire un lot spécifique
Lire une liste de lots
Lire une liste de lots par groupe spécifique
Lire un lot spécifique
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
Récupère une liste de lots dans un groupe pour la constitution d'un catalogue.
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 maximale est de 50 objets par réponse.
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 maximale est de 50 objets par réponse.
Remarque
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.
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.
Sécurité
XsollaLoginUserJWT
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
Requête
Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).
Exemple: offset=0
Langue de la réponse. Code de langue à deux lettres minuscules selon la norme ISO 639-1.
Par défaut "en"
La liste des champs supplémentaires. Ces champs figureront dans la réponse si vous les envoyez dans votre requête.
Éléments Enum"media_list""order""long_description""custom_attributes""item_order_in_group"
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.
Exemple: country=US
Code unique sensible à la casse. Comprend des lettres et des chiffres.
Exemple: promo_code=WINTER2021
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/{project_id}/items/bundle/group/{external_id}
- https://store.xsolla.com/api/v2/project/{project_id}/items/bundle/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/44056/items/bundle/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>'Réponse
application/json
{ "has_more": true, "items": [ { … } ] }
Requête
Récupère des informations sur un lot spécifique.
Note
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.
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.
Sécurité
XsollaLoginUserJWT
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
Requête
Code unique sensible à la casse. Comprend des lettres et des chiffres.
Exemple: promo_code=WINTER2021
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é.
Par défaut 0
Exemple: show_inactive_time_limited_items=1
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/{project_id}/items/bundle/sku/{sku}
- https://store.xsolla.com/api/v2/project/{project_id}/items/bundle/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/44056/items/bundle/sku/kg_1?promo_code=WINTER2021&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Le lot spécifié 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.
Par défaut []
Exemple: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
Type de lot. Utilisez standard pour créer un lot contenant des objets et spécifiez les UGS des objet inclus. Utilisez partner_side_content pour créer un lot vide auquel vous ajouterez des objets de votre côté via un webhook. Ce type est réservé à la Personnalisation du catalogue côté partenaire.
Par défaut "standard"
Enum"standard""partner_side_content"
Exemple: "standard"
Contenu du lot.
Exemple: [{"attributes":[],"description":"Big Rocket - short description.","groups":[],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"name":"Big Rocket","price":{"amount":"10.99","amount_without_discount":"10.99","currency":"USD"},"quantity":100,"sku":"com.xsolla.big_rocket_1","type":"virtual_currency"}]
Un JSON contenant les attributs de l'objet et leurs valeurs.
Description de l'objet.
Exemple: "Big Rocket - description."
Groupes auxquels l'objet appartient.
Par défaut []
Exemple: [{"external_id":"exclusive","name":"Exclusive"}]
Si ce paramètre est défini sur true, l'objet est gratuit.
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.
Ressources supplémentaires du lot.
Exemple: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
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.
Exemple: "bundle_1"
Réponse
application/json
{ "attributes": [], "bundle_type": "standard", "can_be_bought": true, "content": [ { … } ], "custom_attributes": { "attr": "value", "purchased": 0 }, "description": "pricePoint_44056_1.", "groups": [], "image_url": null, "is_free": false, "item_id": 610316, "limits": { "per_user": { … } }, "long_description": null, "media_list": [], "name": "kg_10.00_bundle", "order": 999, "periods": [ { … } ], "price": { "amount": "9.99", "amount_without_discount": "9.99", "currency": "USD" }, "promotions": [], "sku": "com.xsolla.kg_1", "total_content_price": { "amount": "10.99", "amount_without_discount": "10.99", "currency": "USD" }, "type": "bundle", "virtual_prices": [], "vp_rewards": [ { … }, { … } ] }