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

Resgate a etapa da cadeia de oferta gratuitaClient-side

Pedido

Conclui a progressão do usuário atual por meio da etapa da cadeia de ofertas e concede a recompensa associada.

Aviso

Use essa chamada somente para etapas gratuitas na cadeia de ofertas. Para etapas que exigem pagamento em moeda real, use a chamada Criar ordem para a etapa da cadeia de ofertas pagas.
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
offer_chain_idintegerobrigatório

ID de cadeia de ofertas.

Exemplo: 101
step_numberintegerobrigatório

Ofereça o número da etapa da cadeia.

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

Respostas

A etapa gratuita foi resgatada com sucesso e a recompensa concedida.

Corpoapplication/json
order_idinteger

ID de pedido.

Resposta
application/json
{ "order_id": 641 }

Criar ordem para a etapa da cadeia de ofertas pagasClient-side

Pedido

Cria um pedido para o item associado à etapa da cadeia de ofertas pagas especificada. O pedido criado obtém o status new do pedido.

Para abrir a interface do usuário de pagamento em uma nova janela, use o seguinte link: https://secure.xsolla.com/paystation4/?token={token}, onde {token} é o token recebido.

Para fins de teste, use este URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Aviso

Esse método deve ser usado no lado do cliente. O endereço IP do usuário é usado para determinar o país, o que afeta a moeda e os métodos de pagamento disponíveis. Usar esse método do lado do servidor pode resultar na detecção incorreta da moeda e afetar os métodos de pagamento no Pay Station.

Aviso

Use essa chamada somente para etapas da cadeia de ofertas pagas. Para obter etapas gratuitas, use a chamada da cadeia de Resgate a etapa da cadeia de oferta gratuita.
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
offer_chain_idintegerobrigatório

ID de cadeia de ofertas.

Exemplo: 101
step_numberintegerobrigatório

Ofereça o número da etapa da cadeia.

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

Respostas

Pedido criada com sucesso.

Corpoapplication/json
order_idinteger

ID de pedido.

tokenstring

Token de pagamento.

Resposta
application/json
{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }
Operações
Operações
Operações
Operações
Operações