Saltar para o conteúdo

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
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/liveops/
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
Operações

Definir limite de promoção para o usuário especificadoServer-sideAdmin

Pedido

Define o número de vezes que o usuário especificado pode usar uma promoção dentro do limite aplicado depois que ela foi aumentada ou diminuída.

A API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:

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

ID de promoção. Identificador exclusivo da promoção dentro do projeto.

Exemplo: 111425
Corpoapplication/json
availableinteger(User-limit_available_flexible)>= 0obrigatório

Número restante de itens ou usos da promoção disponíveis para o usuário dentro do limite aplicado.

userobject(User-limit_user)obrigatório
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$obrigatório

ID de usuário externo.

curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 0,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respostas

Limites de promoção para um usuário foram recebidos com sucesso.

Corpoapplication/json
per_userobject
Resposta
application/json
{ "per_user": { "available": 9, "total": 10 } }

Atualizar limite de promoção para usuáriosServer-sideAdmin

Pedido

Atualiza o limite da promoção para que um usuário possa usar essa promoção novamente. Se o parâmetro user for null, essa chamada atualizará esse limite para todos os usuários.

A API User limit permite limitar o número de vezes que os usuários podem usar uma promoção. Para configurar o limite de usuário em si, vá para a seção Admin do tipo de promoção desejado:

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

ID de promoção. Identificador exclusivo da promoção dentro do projeto.

Exemplo: 111425
Corpoapplication/json
userobject or null(User-limit_user_flexible)obrigatório
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$

ID de usuário externo.

curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/promotion/id/111425/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respostas

O limite da promoção foi atualizado com sucesso.

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