Saltar para o conteúdo

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
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/shop-builder/
https://store.xsolla.com/api/
Operações

Catálogo personalizado

Essa API permite especificar regras para atributos de usuário. Se o usuário atender a todas as condições para uma regra concreta, serão exibidos itens personalizados.

Para promoções personalizadas, consulte a seção Promotions.

Para passar atributos antes de uma compra, você pode usar a Xsolla Login API ou passá-los para a propriedade user.attributes ao gerar o token usando a Pay Station API.

Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações

Catálogo

Esta API permite obter qualquer tipo de itens vendáveis ou itens específicos.

Operações
Operações
Operações
Operações
Operações
Operações

Cupons

Esta API permite que você gerencie cupons.

Operações

Códigos promocionais

Esta API permite gerenciar códigos promocionais.

Operações

Ofertas de catálogo exclusivas

Essa API permite que você gerencie ofertas de catálogo exclusivas.

Operações

Descontos

Esta API permite-lhe gerir promoções de desconto.

Operações

Bônus

Esta API permite gerenciar promoções de bônus.

Operações
Operações
Operações
Operações
Operações
Operações
Operações

Obter o saldo de pontos de valor do usuário atualClient-side

Pedido

Ponto de extremidade do cliente. Obtém o saldo de pontos de valor do usuário atual.

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
reward_chain_idintegerobrigatório

ID da cadeia de recompensas.

Exemplo: 101
curl -i -X GET \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/user/reward_chain/101/balance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

O saldo de pontos de valor do usuário foi recuperado com sucesso.

Corpoapplication/json
amountinteger

Quantidade de pontos de valor.

descriptionstring or null(value-point-description)

Descrição do ponto de valor.

image_urlstring(Common_admin-image_url)

URL da imagem.

Exemplo: "https://image.example.com"
is_clanboolean(is_clan)

Se o ponto de valor é usado em cadeias de recompensa de clã ou não.

Exemplo: true
long_descriptionstring or null(value-point-long-description)

Descrição longa do ponto de valor.

namestring(value-point-name)

Nome do ponto de valor.

skustring(value-point-sku)

ID de ponto de valor exclusivo.

Resposta
application/json
{ "amount": 80, "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "long_description": "Value points given to clans to get new rewards in a reward chain.", "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" }

Resgatar recompensa por etapaClient-side

Pedido

Ponto de extremidade do cliente. Reivindica a recompensa de passo do usuário atual de uma cadeia de recompensas.

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
reward_chain_idintegerobrigatório

ID da cadeia de recompensas.

Exemplo: 101
step_idintegerobrigatório

ID de etapa de cadeia de recompensa.

Exemplo: 120
curl -i -X POST \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/user/reward_chain/101/step/120/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

Reivindicou com sucesso a recompensa de passo do usuário atual de uma cadeia de recompensas.

Resposta
Sem conteúdo
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações