ID du groupe.
Catalog API (2.0.0)
- Version : 2.0.0
- Serveurs :
https://store.xsolla.com/api - Contactez-nous par e-mail
- **URL de contact :**https://xsolla.com/
- Version TLS requise : 1.2
L’API Catalog permet de configurer un catalogue des objets en jeu côté Xsolla et de l’afficher aux utilisateurs dans votre magasin.
L’API permet de gérer les entités de catalogue suivantes :
- Objets virtuels — objets en jeu tels que armes, skins, boosters.
- Monnaie virtuelle — monnaie utilisée pour acheter des objets virtuels.
- Packages de monnaie virtuelle — lots prédéfinis de monnaie virtuelle.
- Lots — packages combinant objets virtuels, monnaie virtuelle ou clés de jeu vendus sous un seul UGS.
- Clés de jeu — clés pour jeux et DLC distribuées via Steam ou d’autres fournisseurs DRM.
- Groupes — regroupements logiques pour organiser et trier les éléments du catalogue.
L’API est divisée en groupes suivants :
Admin — appels pour créer, mettre à jour, supprimer et configurer les objets et groupes du catalogue. Authentification via l’authentification d’accès de base avec vos identifiants marchand ou projet. Non destinés à un usage côté magasin.Catalog — appels pour récupérer des objets et construire des vitrines personnalisées pour les utilisateurs finaux. Conçue pour gérer des charges importantes. Supporte l’autorisation optionnelle par JWT utilisateur pour retourner des données personnalisées telles que des limites spécifiques à l’utilisateur et des promotions actives.
Télécharger la description d'OpenAPI
Langues
Serveurs
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/fr/api/catalog/
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/{project_id}/admin/items/bundle/group/id/{group_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v2/project/44056/admin/items/bundle/group/id/10?limit=50&offset=0'Réponse
application/json
{ "items": [ { … }, { … } ] }
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/bundle/sku/{sku}
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/{project_id}/admin/items/bundle/sku/{sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/items/bundle/sku/kg_1Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/bundle/sku/{sku}
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/{project_id}/admin/items/bundle/sku/{sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/items/bundle/sku/kg_1Le lot spécifié a été reçu avec succès.
Liste des attributs.
Exemple: [{"external_id":"attribute_external_id","name":{"de":"Attributname","en":"Attribute name"},"values":[{"external_id":"value_1","name":{"de":"wert 1","en":"value 1"}},{"external_id":"value_2","name":{"de":"wert 2","en":"value 2"}}]}]
Type de lot. Renvoyé si le type d'objet est un lot.
Enum"standard""virtual_currency_package""partner_side_content"
Un JSON contenant les attributs de l'objet et leurs valeurs.
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.
Groupes auxquels l'objet appartient.
Par défaut []
Exemple: [{"external_id":"horror","name":{"en":"Horror"}}]
Si ce paramètre est désactivé, l'objet ne peut pas être trouvé ni acheté.
Par défaut true
Exemple: true
Si ce paramètre est défini sur true, l'objet est gratuit.
Par défaut false
Exemple: false
Si l’objet est une récompense payante aléatoire (par exemple, une boîte à butin).
Par défaut false
Exemple: false
L'objet est disponible à l'achat.
Par défaut false
Exemple: true
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"}]
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.
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", "content": [ { … }, { … }, { … } ], "custom_attributes": { "purchased": 0, "type": "lootbox" }, "description": { "en": "Empire bundle with items" }, "groups": [ { … } ], "image_url": "https://cdn.xsolla.net/img/misc/images/685b21f9d9dca4aa0c953e8816b4eb4b.png", "is_enabled": true, "is_free": false, "is_paid_randomized_reward": true, "is_show_in_store": true, "item_id": 610316, "limits": { "per_item": null, "per_user": { … }, "recurrent_schedule": null }, "long_description": { "en": "Empire bundle with some goods" }, "media_list": [], "name": { "en": "Empire bundle" }, "order": 1, "periods": [ { … } ], "prices": [], "regions": [], "sku": "com.xsolla.EmpireBundle_1", "type": "bundle", "virtual_prices": [ { … } ] }