Saltar para o conteúdo
/
Redefinir recompensa diár...

API Shop Builder (2.0.0)

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
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/shop-builder/
https://store.xsolla.com/api/

Admin

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

Admin

Operações

Catálogo

Operações

Carrinho (lado do cliente)

Operações

Carrinho (lado do servidor)

Operações

Pagamento (lado do cliente)

Operações

Pagamento (lado do servidor)

Operações

Pedido

Operações

Itens gratuitos

Operações

Webhooks

Operações

Reservas

Operações

Comerciante

Operações

Catálogo

Esta API permite obter qualquer tipo de itens vendáveis ou itens específicos.

Operações

Regiões comuns

Operações

Catálogo

Operações

Direito

Operações

Admin

Operações

Comum

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

Admin

Operações

Catálogo

Operações

Pagamento virtual

Operações

Gestão

Operações

Admin

Operações

Cliente

Operações

Cliente de clãs

Operações

Admin

Operações

Cliente

Operações

Admin

Operações

Atualizar recompensa diáriaServer-sideAdmin

Pedido

Atualiza uma recompensa diária específica.

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

ID de recompensa diária.

Exemplo: 101
Corpoapplication/json
One of:

Uma recompensa diária pelo tipo calendar_hard.

date_startstring(date-time)(calendar_hard_date_start)obrigatório

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

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.

description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)

Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

One of:

Objeto com traduções para a descrição do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

idinteger(daily_chain_id)

ID de recompensa diária exclusivo.

Exemplo: 9
is_enabledboolean(is_enabled)obrigatório
Exemplo: true
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)obrigatório

Objeto com traduções para o nome do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de idioma de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

One of:

Objeto com traduções para o nome do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de idioma de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as opções para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.

name.​arstring or null

Árabe

name.​bgstring or null

Búlgaro

name.​cnstring or null

Chinês (Simplificado)

name.​csstring or null

Tcheco

name.​destring or null

Alemão

name.​enstring or null

Inglês

name.​esstring or null

Espanhol (Espanha)

name.​frstring or null

Francês

name.​hestring or null

Hebraico

name.​idstring or null

Indonésio

name.​itstring or null

Italiano

name.​jastring or null

Japonês

name.​kmstring or null

Khmer

name.​kostring or null

Coreano

name.​lostring or null

Lao

name.​mystring or null

Birmanês

name.​nestring or null

Nepalês

name.​phstring or null

Filipino

name.​plstring or null

Polonês

name.​ptstring or null

Português

name.​rostring or null

Romeno

name.​rustring or null

Russo

name.​thstring or null

Tailandês

name.​trstring or null

Turco

name.​twstring or null

Chinês (Tradicional)

name.​vistring or null

Vietnamita

orderinteger(order)

Define a ordem do arranjo.

Exemplo: 1
stepsArray of objects(modify-daily-chain-step-model)obrigatório
steps[].​itemsArray of objects(modify-daily-chain-item-model)non-emptyobrigatório
steps[].​items[].​quantityinteger>= 1obrigatório

Quantidade de etapas de recompensa diária para este sku

steps[].​items[].​skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$obrigatório

ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.

Exemplo: "booster_mega_1"
steps[].​step_idinteger or null(daily_chain_update_step_id)>= 1

Identificador exclusivo da etapa de recompensa diária. Especifique-o durante a atualização para reter o progresso do usuário nesta etapa.

Exemplo: 10
steps[].​step_numberinteger(daily_chain_step_number)>= 1obrigatório

Número da etapa.

Exemplo: 2
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/daily_chain/id/101 \
  -H 'Content-Type: application/json' \
  -d '{
    "date_start": "2023-04-15T18:16:00+05:00",
    "description": {
      "en": "Updated daily reward description"
    },
    "is_enabled": true,
    "name": {
      "en": "Updated daily reward",
      "ru": "Обновленная ежедневная награда"
    },
    "order": 4,
    "steps": [
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_enabled_shown_in_store_1"
          }
        ],
        "step_number": 1
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_enabled_shown_in_store_2"
          }
        ],
        "step_number": 2
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vg_not_shown_in_store"
          }
        ],
        "step_id": 10,
        "step_number": 3
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "bundle_enabled_shown_in_store_with_2_enabled_shown_in_store_vg"
          }
        ],
        "step_id": 8,
        "step_number": 4
      },
      {
        "items": [
          {
            "quantity": 1,
            "sku": "vcp_enabled_shown_in_store_1_of_10_vc_enabled_shown_in_store_1"
          }
        ],
        "step_number": 5
      }
    ],
    "type": "calendar_hard"
  }'

Respostas

Recompensa diária atualizada com sucesso.

Corpo
Resposta
Sem conteúdo

Redefinir recompensa diáriaServer-sideAdmin

Pedido

Redefine o progresso para todos os usuários na recompensa diária. Aplica-se apenas a recompensas diárias do tipo rolling.

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

ID de recompensa diária.

Exemplo: 101
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/daily_chain/id/101/reset

Respostas

A recompensa diária foi redefinida.

Corpo
Resposta
Sem conteúdo

Alternar recompensa diáriaServer-sideAdmin

Pedido

Ativa ou desativa uma recompensa diária.

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

ID de recompensa diária.

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

Respostas

A recompensa diária foi desativada ou ativada.

Corpo
Resposta
Sem conteúdo

Cliente

Operações

Admin

Operações

Cliente

Operações

Admin

Operações