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

Obter recompensas diárias do usuário atualClient-side

Pedido

Ponto de extremidade do cliente. Obtém as recompensas diárias do usuário atual.

Aviso

Um método retorna uma lista paginada de itens. O valor máximo e padrão é de 50 itens por resposta. Para obter mais itens da lista, use os parâmetros `limit` e `offset`, e busque mais páginas. Por exemplo, ao chamar um método com 'limit = 25' e 'offset = 100', a resposta retorna 25 itens a partir do 101º item na lista geral.
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/daily_chain?limit=50&offset=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

As recompensas diárias do usuário foram recuperadas com sucesso.

Corpoapplication/json
has_moreboolean

Usado como um indicador de que há mais páginas.

Exemplo: true
itemsArray of any(client-daily-chain-model)
total_items_countinteger

Número total de recompensas diárias.

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

Obtém a recompensa diária do usuário atual por seu IDClient-side

Pedido

Ponto de extremidade do cliente. Obtém a recompensa diária do usuário atual por seu ID.

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

ID de recompensa diária.

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

Respostas

As recompensa diária do usuário foi recuperada com sucesso.

Corpoapplication/json
date_startstring(date-time)(calendar_hard_date_start)

Data em que sua cadeia de recompensas diárias começa.

Exemplo: "2020-04-15T18:16:00+05:00"
is_recurrentboolean(calendar_hard_is_recurrent)

Se a recompensa diária é recorrente. Se true, a recompensa diária será redefinida automaticamente após a data de término. O próximo cronograma start_date e end_date são baseados na quantidade de etapas de recompensas diárias e no tempo inicial definido em start_date.

Padrão false
Exemplo: true
typestring

Tipo de recompensa diária que determina quando os usuários podem resgatar recompensas.

Enum ValorDescrição
calendar_hard

Desbloqueia a recompensa da próxima etapa a cada 24 horas. Quaisquer recompensas de etapas não resgatadas são perdidas permanentemente quando a recompensa da próxima etapa ficar disponível.

rolling_skippable

Desbloqueia a recompensa da próxima etapa a cada 24 horas com base em date_start. A progressão é sequencial: uma nova recompensa não será desbloqueada até que a anterior seja resgatada. Se um usuário pular um ou mais dias, ele continuará de onde parou; Os dias perdidos não concedem múltiplas recompensas.

rolling_unskippable

Desbloqueia a recompensa da próxima etapa a cada 24 horas com base em date_start. A progressão é sequencial: uma nova recompensa não será desbloqueada até que a anterior seja resgatada. No entanto, se um usuário pular um dia, seu progresso é redefinido e ele deverá começar novamente a partir da primeira etapa.

Discriminador
date_endstring or null(date-time)(daily_chain_date_end)

Data em que sua recompensa diária termina. Pode ser null. Definir como tipo calendar_hard definirá automaticamente essa data com base no número de etapas adicionadas, então você pode deixá-la como null.

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

Descrição da recompensa diária.

Exemplo: "Major weekly quest"
idinteger

ID de recompensa diária.

Exemplo: 9
namestring

Nome da recompensa diária.

Exemplo: "Weekly quest"
orderinteger(order)

Define a ordem do arranjo.

Exemplo: 1
stepsArray of objects(client-daily-chain-step-model)
Resposta
application/json
{ "date_end": "2025-04-03T18:16:00+05:00", "date_start": "2025-04-01T18:16:00+05:00", "description": "Active daily reward description", "id": 101, "name": "Active daily reward", "order": 1, "steps": [ {}, {}, {}, {} ], "type": "calendar_hard" }

Resgatar etapa da recompensa diáriaClient-side

Pedido

Ponto de extremidade do cliente. Resgata a recompensa de etapa do usuário atual a partir de uma recompensa diária. Todas as etapas só podem ser resgatadas em ordem sequencial. A recompensa de uma etapa perdida não pode ser obtida com moedas virtuais ou reais, nem assistindo a um anúncio.

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

ID de recompensa diária.

Exemplo: 101
step_numberintegerobrigatório

Número da etapa de recompensa diária.

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

Respostas

Resgatou a recompensa de etapa do usuário atual por uma etapa de recompensa diária com sucesso.

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