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

Desativar promoção de código promocionalServer-sideAdmin

Pedido

Desativa uma promoção de código promocional.

A promoção de código promocional criada inicia desativada por padrão. Ele não estará pronto para resgate até que você o ative. Use esse ponto de extremidade para desabilitar e desativar uma promoção de código promocional.

Segurança
basicAuth
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
external_idintegerobrigatório

ID externo de promoção. Identificador exclusivo da promoção dentro do projeto.

Exemplo: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/promocode/coupon_44056_1/deactivate

Respostas

O cupom foi desativado com sucesso.

Resposta
Sem conteúdo

Obter limite de código promocional para o usuário especificadoServer-sideAdmin

Pedido

Obtém o número restante de vezes que o usuário especificado pode usar o código promocional.

A API User limit permite limitar o número de vezes que os usuários podem usar um código promocional. Para configurar o limite de usuário em si, vá para a seção Admin:

Segurança
basicAuth
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
external_idintegerobrigatório

ID externo de promoção. Identificador exclusivo da promoção dentro do projeto.

Exemplo: coupon_44056_1
Consulta
user_external_idstringobrigatório

ID externo de usuário

Exemplo: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/user/limit/promocode/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Respostas

Limites de código promocional recebidos com sucesso para um usuário.

Corpoapplication/json
per_userobject
Resposta
application/json
{ "per_user": { "available": 9, "total": 10 } }

Obter recompensas de código promocionalClient-side

Pedido

Recebe recompensas de código promocional pelo seu código. Pode ser usado para permitir que os usuários escolham um dos muitos itens como bônus. O caso usual é escolher um DRM se o código promocional contiver um jogo como bônus (type=unit).

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
promocode_codestring[ 1 .. 128 ] charactersobrigatório

Código exclusivo que diferencia maiúsculas de minúsculas. Contém letras e números.

Exemplo: SO6rew99j9
curl -i -X GET \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/promocode/code/SO6rew99j9/rewards \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

Lista de recompensas do código promocional recebida com sucesso.

Corpoapplication/json
bonusArray of objects(Promotions_200-promo-code-bonus-reward)
discountobject or null(Promotions_200-coupon-discount-reward)

Percentual de desconto. O preço do carrinho será reduzido usando um valor calculado usando essa porcentagem e, em seguida, arredondado para 2 casas decimais.

discounted_itemsArray of objects or null(Promotions_discounted_items)

Lista de itens que são descontados por um código promocional.

is_selectableboolean

Se true, o usuário deve escolher o bônus antes de resgatar um código promocional.

Resposta
application/json
{ "bonus": [ {}, {} ], "discount": { "percent": "10.00" }, "discounted_items": [ {} ], "is_selectable": true }

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
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações