Saltar para o conteúdo
/
Criar promoção de oferta...

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

Obter lista de promoções exclusivas de ofertas de catálogoServer-sideAdmin

Pedido

Obtém a lista de promoções de ofertas de catálogo exclusivas de um projeto.

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
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 \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v3/project/44056/admin/unique_catalog_offer?limit=50&offset=0'

Respostas

A lista de cupons foi recebida com sucesso.

Corpoapplication/json
active_promotions_countinteger(active_promotions_count)

Número de promoções ativas.

inactive_promotions_countinteger(inactive_promotions_count)

Número de promoções desativadas.

itemsArray of objects(Promotions_200-get-unique-catalog-offer-promotion-model)
total_promotions_countinteger(total_promotions_count)

Número total de promoções.

Resposta
application/json
{
  "active_promotions_count": 2,
  "inactive_promotions_count": 0,
  "items": [
    { … },
    { … }
  ],
  "total_promotions_count": 2
}

Criar promoção de oferta de catálogo exclusivaServer-sideAdmin

Pedido

Cria uma promoção exclusiva de oferta de catálogo.

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
Corpoapplication/json
date_endstring or null(date-time)(Promotions_coupon_date_end)

Data em que sua promoção será concluída. Pode ser null. Se date_end for null, a promoção terá um tempo ilimitado.

Padrão "2020-04-15T18:16:00+05:00"
date_startstring or null(date-time)(Promotions_coupon_date_start)

Data em que sua promoção será iniciada.

Padrão "2020-04-15T18:16:00+05:00"
external_idstring(Promotions_coupon-external_id)obrigatório

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

Padrão "coupon_external_id"
Exemplo: "coupon_external_id"
itemsArray of strings(Promotions_unique_catalog_offer_items)

Uma lista de itens SKU que estão disponíveis depois de usar a oferta de catálogo exclusivo.

Exemplo: ["booster_mega_1"]
nameobject(Promotions_coupon_name)obrigatório

Nome da promoção. Deve conter pares chave/valor onde a chave é uma localidade com formato "^[a-z]{2}-[A-Z]{2}$", e valor sendo uma cadeia de caracteres.

Padrão {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
Exemplo: {"de-DE":"Gutscheintitel","en-US":"Coupon title"}
name.​property name*stringpropriedade adicional
redeem_code_limitinteger or null(Promotions_redeem_code_limit)

Número de resgates por código.

Padrão 10
Exemplo: 10
redeem_total_limitinteger or null(Promotions_coupon-redeem_total_limit)

Limita o número total de cupons.

Padrão 10
Exemplo: 10
redeem_user_limitinteger or null(Promotions_coupon-redeem_user_limit)

Limita o número total de cupons resgatados por um único usuário.

Padrão 10
Exemplo: 10
curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/unique_catalog_offer \
  -H 'Content-Type: application/json' \
  -d '{
    "date_end": "2020-04-25T18:16:00+05:00",
    "date_start": "2020-04-15T18:16:00+05:00",
    "external_id": "offer_external_id",
    "items": [
      "elven_sword",
      "elven_boots"
    ],
    "name": {
      "de-DE": "Neujahrsangebot",
      "en-US": "New Year Offer"
    },
    "redeem_code_limit": 1,
    "redeem_total_limit": 100,
    "redeem_user_limit": 1
  }'

Respostas

A oferta de catálogo exclusiva foi criada com sucesso.

Corpoapplication/json
external_idstring(Promotions_coupon-external_id)

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

Padrão "coupon_external_id"
Exemplo: "coupon_external_id"
Resposta
application/json
{
  "external_id": "coupon_external_id"
}

Excluir promoção de oferta de catálogo exclusivaServer-sideAdmin

Pedido

Exclui a promoção de oferta de catálogo único. A promoção excluída:

  • Desaparece da lista de promoções configuradas no seu projeto.
  • Não se aplica mais ao catálogo de itens e ao carrinho. O usuário não pode comprar itens com esta promoção.

Após a exclusão, a promoção não poderá ser restaurada.

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

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

Exemplo: coupon_44056_1
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/unique_catalog_offer/coupon_44056_1

Respostas

Oferta de catálogo exclusiva excluída com sucesso.

Resposta
Sem conteúdo

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

Cliente

Operações