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

Obter limite de cupons de um usuário específicoServer-sideAdmin

Pedido

Obtém o número restante de vezes que o usuário especificado pode usar o cupom.

A API User limit permite limitar o número de vezes que os usuários podem usar um cupom. Para configurar o próprio limite de usuário, 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/coupon/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Respostas

Limites de cupom recebidos com sucesso para um usuário.

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

Obter recompensas de cupomClient-side

Pedido

Recebe cupons de recompensa por 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 cupom 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
coupon_codestring[ 1 .. 128 ] charactersobrigatório

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

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

Respostas

Lista de recompensas de cupom recebida com sucesso.

Corpoapplication/json
bonusArray of objects(Promotions_200-coupon-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.

is_selectableboolean

Se true, o usuário deve escolher o bônus antes de resgatar um cupom.

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

Resgatar código de cupomClient-side

Pedido

Resgata um código de cupom. O usuário recebe um bônus depois que um cupom é resgatado.

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
Corpoapplication/json
coupon_codestring[ 1 .. 128 ] characters

Código de cupom exclusivo. Contém letras e números.

Padrão "WINTER2021"
Exemplo: "WINTER2021"
selected_unit_itemsobject(Promotions_selected_unit_items)

A recompensa selecionada por um usuário. A chave de objeto é um SKU de uma unidade, e o valor é um SKU de um dos itens em uma unidade.

Exemplo: {"game_1":"game_1_steam","game_2":"game_2_playstation"}
curl -i -X POST \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/coupon/redeem \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021",
    "selected_unit_items": {
      "game_1": "game_1_steam",
      "game_2": "game_2_playstation"
    }
  }'

Respostas

Cupom resgatado com sucesso.

Corpoapplication/json
itemsArray of objects
Exemplo: [{"attributes":[],"description":"Take it, take it all! All of Xsolla's riches in one Mega Booster.","groups":[{"external_id":"powerups","name":"Power Ups"}],"image_url":"https://cdn.xsolla.net/img/misc/images/e9f2f4a634bc96ea03b5d5ceadd7c55f.png","is_free":false,"name":"Xsolla Booster Mega","price":{"amount":"50.0000000000000000","amount_without_discount":"100.0000000000000000","currency":"USD"},"quantity":1,"sku":"com.xsolla.booster_mega_1","type":"virtual_good","virtual_item_type":"consumable","virtual_prices":[]}]
Resposta
application/json
{ "items": [ {} ] }

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