Saltar para o conteúdo
/
Criar venda cruzada

LiveOps API (2.0.0)

Visão geral

  • Versão: 2.0.0
  • Servidores: https://store.xsolla.com/api
  • Contate-nos por e-mail
  • URL de contato: https://xsolla.com/
  • Versão TLS necessária: 1.2

LiveOps é um kit de ferramentas para gerar engajamento contínuo com os jogadores através de promoções e ofertas personalizadas.

Use a API para gerenciar os seguintes recursos:

  • Promoções — crie e gerencie cupons, códigos promocionais, descontos e campanhas bônus.
  • Personalização — especifique as condições para exibir o catálogo de itens e aplicar as promoções somente para certos usuários autorizados.
  • Limites de promoção — defina um limite sobre quantas vezes uma promoção pode ser usada por um usuário e configure as redefinições programadas para esses limites.
  • Cadeias de recompensas e pontos de valor — configure a progressão de recompensas vinculada ao acúmulo de pontos de valor.
  • Cadeias diárias — configure recompensas diárias recorrentes para motivar acessos regulares.
  • Cadeias de ofertas — construa ofertas de compra sequenciais com precificações por etapa e opções de recompensas gratuitas.
  • Venda cruzada — um método de venda na qual o usuário recebe a oferta de comprar um item com valor adicional.

Chamadas API

A API se divide nos seguintes grupos:

  • Admin — chamadas para criar, atualizar, ativar e excluir campanhas e configurações de cadeias. Autenticada via autenticação de acesso básica com seu comerciante ou as credenciais do projeto.
  • Client — chamadas para recuperar as promoções disponíveis, obter cadeias ativas, resgatar códigos e resgatar recompensas em nome de usuários finais autenticados. Autenticado via JWT de usuário.
Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/liveops/

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

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

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

Cliente

Operações

Admin

Operações

Obter informações sobre venda cruzada no projetoServer-sideAdmin

Pedido

Recupera as informações sobre a venda cruzada no projeto: se está habilitado, o tipo de venda cruzada e a lista de SKUs de itens que fazem parte dessa venda cruzada.

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
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respostas

A lista de detalhes de configuração e itens usados para venda cruzada no projeto.

Corpoapplication/jsonArray [
is_enabledboolean

Se a venda cruzada está habilitada para o projeto.

Exemplo: true
itemsArray of objects

A lista de SKUs de itens que fazem parte da venda cruzada no projeto.

Exemplo: [{"item_id":1,"name":{"de":"Name des Artikels","en":"Item's name"},"sku":"com.xsolla.booster_mega_1","type":"virtual_good"}]
typestring

O tipo de venda cruzada.

Enum"fixed_list""most_sellable""only_promotions"
Exemplo: "fixed_list"
]
Resposta
application/json
[
  {
    "is_enabled": true,
    "items": [ … ],
    "type": "fixed_list"
  }
]

Criar venda cruzadaServer-sideAdmin

Pedido

Cria uma venda cruzada para um projeto.

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
One of:

Tipo de venda cruzada.

is_enabledboolean(is_enabled)obrigatório
Exemplo: true
itemsArray of stringsobrigatório

Matriz de itens SKU.

Padrão null
Exemplo: ["game_sku"]
typestringobrigatório
Valor"fixed_list"
Exemplo: true
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Respostas

A venda cruzada foi criada para o projeto.

Resposta
Sem conteúdo

Atualizar venda cruzadaServer-sideAdmin

Pedido

Atualize uma venda cruzada para um projeto.

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
One of:

Tipo de venda cruzada.

is_enabledboolean(is_enabled)obrigatório
Exemplo: true
itemsArray of stringsobrigatório

Matriz de itens SKU.

Padrão null
Exemplo: ["game_sku"]
typestringobrigatório
Valor"fixed_list"
Exemplo: true
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/admin/items/upsell \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "items": [
      "game_sku_1",
      "game_sku_2",
      "game_sku_3"
    ],
    "type": "fixed_list"
  }'

Respostas

A venda cruzada foi atualizada para o projeto.

Resposta
Sem conteúdo

Cliente

Operações