Saltar para o conteúdo
/
Obter o saldo virtual do...

API Shop Builder (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.

Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/deprecated/inventory/
https://store.xsolla.com/api/

Cliente

Operações

Consumir itemClient-side

Pedido

Ponto de extremidade do cliente. Consome um item do inventário do usuário atual.

Segurança
XsollaLoginUserJWT
Caminho
project_idintegerobrigatório

ID do projeto.

Padrão 44056
Consulta
platformstring

Plataforma de publicação em que o usuário joga.

Padrão "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
Corpoapplication/json
quantitynumberobrigatório

Quantidade do item.

Padrão 1
Exemplo: 1
skustringobrigatório

ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.

Padrão "booster_mega_1"
Exemplo: "booster_mega_1"
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/pt/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"
  }'

Respostas

Item do inventário do usuário consumido.

Resposta
Sem conteúdo

Obter o inventário do usuário atualClient-side

Pedido

Ponto de extremidade do cliente. Recupera o inventário do usuário atual.

Atenção

Todos os projetos têm a limitação do número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
Segurança
XsollaLoginUserJWT
Caminho
project_idintegerobrigatório

ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.

Exemplo: 44056
Consulta
limitinteger>= 1

Limite da quantidade de elementos na página.

Exemplo: limit=50
offsetinteger>= 0

Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).

Exemplo: offset=0
platformstring

Plataforma de publicação em que o usuário joga.

Padrão "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/pt/api/deprecated/inventory/v2/project/44056/user/inventory/items?limit=50&offset=0&platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

O inventário do usuário foi recuperado com sucesso.

Corpoapplication/json
itemsArray of objects
Exemplo: [{"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"}]
Resposta
application/json
{
  "items": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Obter itens de tempo limitado do usuário atualClient-side

Pedido

Ponto de extremidade do cliente. Recupera os itens de tempo limitado do usuário atual.

Segurança
XsollaLoginUserJWT
Caminho
project_idintegerobrigatório

ID do projeto.

Padrão 44056
Consulta
platformstring

Plataforma de publicação em que o usuário joga.

Padrão "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/pt/api/deprecated/inventory/v2/project/{project_id}/user/time_limited_items?platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

Os itens de tempo limitado do usuário foram recuperados com sucesso.

Corpoapplication/json
itemsArray of objects
Exemplo: [{"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"}]
Resposta
application/json
{
  "items": [
    { … },
    { … },
    { … }
  ]
}

Obter o saldo virtual do usuário atualClient-side

Pedido

Ponto de extremidade do cliente. Recupera o saldo virtual do usuário atual.

Segurança
XsollaLoginUserJWT
Caminho
project_idintegerobrigatório

ID do projeto.

Padrão 44056
Consulta
platformstring

Plataforma de publicação em que o usuário joga.

Padrão "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/pt/api/deprecated/inventory/v2/project/{project_id}/user/virtual_currency_balance?platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

O saldo virtual do usuário foi recuperado com sucesso.

Corpoapplication/json
itemsArray of objects
Exemplo: [{"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"}]
Resposta
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Gestão

Operações

Inventário multiplataforma

Operações