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

Obtenha as cadeias de ofertas do usuário atualClient-side

Pedido

Obtém as cadeias de ofertas atuais do usuário.

Aviso

Todos os projetos têm um limite no número de itens que podem ser retornados em uma única resposta. O valor padrão e máximo é de 30 itens por resposta. Para obter mais dados, use os parâmetros de consulta limit e offset para a paginação.
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
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/user/offer_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

A lista de cadeias de ofertas foi recebida com êxito.

Corpoapplication/json
has_moreboolean

Indica se há mais páginas disponíveis.

Exemplo: true
itemsArray of objects(client-offer-chain-model)
total_items_countinteger

Número total de cadeias de ofertas disponíveis.

Exemplo: 10
Resposta
application/json
{ "has_more": false, "items": [ {}, {}, {} ], "total_items_count": 3 }

Obter a cadeia de ofertas do usuário atual por IDClient-side

Pedido

Obtém a cadeia de ofertas do usuário atual pela ID da cadeia de ofertas.

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
curl -i -X GET \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/user/offer_chain/101 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

A cadeia de ofertas do usuário foi recuperada com sucesso.

Corpoapplication/json
date_endstring or null(date-time)(offer_chain_date_end)

Data em que a cadeia de ofertas termina. Pode ser null. Se date_end for null, a cadeia de ofertas não terá um limite de tempo.

Exemplo: "2020-04-15T18:16:00+05:00"
date_startstring(date-time)(offer_chain_date_start)

Data em que a cadeia de ofertas é iniciada.

Exemplo: "2020-04-15T18:16:00+05:00"
descriptionstring or null

Descrição da cadeia de ofertas.

Exemplo: "Major weekly quest"
idinteger

ID de cadeia de ofertas.

Exemplo: 9
namestring

Nome da cadeia de ofertas.

Exemplo: "Weekly quest"
next_step_numberinteger or null

Número da próxima etapa da cadeia de ofertas. null se a cadeia de ofertas foi concluída.

Exemplo: 1
orderinteger(order)

Define a ordem do arranjo.

Exemplo: 1
recurrent_scheduleobject or null(offer_chain_recurrent_schedule_client_side)

Período de redefinição da cadeia de ofertas.

stepsArray of objects(client-offer-chain-step-model)
Resposta
application/json
{ "date_end": "2025-04-25T18:16:00+05:00", "date_start": "2010-04-15T18:16:00+05:00", "description": null, "id": 4, "name": "Offer chain with bundles", "next_step_number": 1, "order": 1, "recurrent_schedule": null, "steps": [ {}, {} ] }

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