Passer au contenu
/
Lire le solde virtuel act...

Shop Builder API (2.0.0)

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
index.json
index.yaml
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/deprecated/inventory/
https://store.xsolla.com/api/

Client

Opérations

Consommer un objetClient-side

Requête

Endpoint client. Consomme un objet de l'inventaire actuel d'un utilisateur.

Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet.

Par défaut 44056
Requête
platformstring

Plateforme de publication sur laquelle l'utilisateur joue.

Par défaut "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
Corpsapplication/json
quantitynumberobligatoire

Quantité de l'objet.

Par défaut 1
Exemple: 1
skustringobligatoire

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.

Par défaut "booster_mega_1"
Exemple: "booster_mega_1"
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/fr/api/deprecated/inventory/v2/project/{project_id}/user/inventory/item/consume?platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 1,
    "sku": "booster_mega_1"
  }'

Réponses

Un objet de l'inventaire utilisateur a été consommé.

Réponse
Aucun contenu

Lire l'inventaire actuel de l'utilisateurClient-side

Requête

Endpoint client. Récupère l'inventaire actuel de l'utilisateur.

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 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
platformstring

Plateforme de publication sur laquelle l'utilisateur joue.

Par défaut "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/fr/api/deprecated/inventory/v2/project/44056/user/inventory/items?limit=50&offset=0&platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

L'inventaire de l'utilisateur a été récupéré avec succès.

Corpsapplication/json
itemsArray of objects
Exemple: [{"attributes":[],"description":"Big Rocket - short description","groups":[],"image_url":"https://picture.bigrocket.png","instance_id":null,"name":"Rocket","quantity":null,"remaining_uses":1,"sku":"com.xsolla.instanciated_item_1","type":"virtual_good","virtual_item_type":"non_consumable"},{"attributes":[],"description":"description","groups":[],"image_url":"http://image.png","instance_id":null,"name":"SHOTGUN FOR TRUE RAIDERS","quantity":2,"remaining_uses":1,"sku":"com.xsolla.shotgun_raider_1","type":"virtual_good","virtual_item_type":"non_consumable"},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"stack_size_value_99c25352ab6e34a0e0755fc2a9daa7a76021dce2","value":5}]},{"external_id":"licensed","name":"Licensed","values":[{"external_id":"licensed_value_d75d8034dd2f82cb3d2789f5ec1837a6c350b505","value":true}]}],"description":null,"groups":[],"image_url":null,"instance_id":null,"name":"HEADPHONES","quantity":5,"remaining_uses":1,"sku":"com.xsolla.headphones_for_pro_1","type":"virtual_good","virtual_item_type":"non_consumable"},{"attributes":[],"description":null,"groups":[],"image_url":null,"instance_id":null,"name":"UNIQUE DIAMONDS","quantity":100,"remaining_uses":1,"sku":"com.xsolla.platform_currency_1","type":"virtual_currency"}]
Réponse
application/json
{
  "items": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Lire les objets à durée limitée actuels d'un utilisateurClient-side

Requête

Endpoint client. Récupère les objets à durée limitée actuels d'un utilisateur.

Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet.

Par défaut 44056
Requête
platformstring

Plateforme de publication sur laquelle l'utilisateur joue.

Par défaut "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/fr/api/deprecated/inventory/v2/project/{project_id}/user/time_limited_items?platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

Les objets à durée limitée de l'utilisateur ont été récupérés avec succès.

Corpsapplication/json
itemsArray of objects
Exemple: [{"amount":10,"description":"Ruble","image_url":"https://picture.bigrocket.png","name":"Ruble","sku":"com.xsolla.VC_1","type":"virtual_currency","virtual_item_type":"non_renewing_subscription"},{"amount":5000,"description":"Xsollar","image_url":"http://image.png","name":"Xsollar","sku":"com.xsolla.VC_2","type":"virtual_currency","virtual_item_type":"non_renewing_subscription"}]
Réponse
application/json
{
  "items": [
    { … },
    { … },
    { … }
  ]
}

Lire le solde virtuel actuel de l'utilisateurClient-side

Requête

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

Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet.

Par défaut 44056
Requête
platformstring

Plateforme de publication sur laquelle l'utilisateur joue.

Par défaut "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/fr/api/deprecated/inventory/v2/project/{project_id}/user/virtual_currency_balance?platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Réponses

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

Corpsapplication/json
itemsArray of objects
Exemple: [{"description":"The PLEX or “30-day Pilot's License EXtension” is a virtual item that represents 30 days of subscription time and can be bought for cash and then sold to other players for in-game ISK.","expired_at":1746057600,"image_url":"https://picture.bigrocket.png","name":"PLEX","sku":"com.xsolla.plex_1","status":"active","type":"virtual_good","virtual_item_type":"non_renewing_subscription"},{"description":"WoW token allows players to buy game time World of Warcraft for money and sell it for game gold at auction.","expired_at":1546304461,"image_url":"https://picture.bigrocket.png","name":"WoW Token","sku":"com.xsolla.token_1","status":"expired","type":"virtual_good","virtual_item_type":"non_renewing_subscription"}]
Réponse
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Gestion

Opérations

Inventaire multiplateforme

Opérations