Saltar para o conteúdo

LiveOps API (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

LiveOps API fornece endpoints para aumentar o engajamento dos jogadores.

Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/liveops/
https://store.xsolla.com/api/

Comum

Operações

Cupons

Esta API permite que você gerencie cupons.

Operações

Obtenha limites de código de cupom exclusivosServer-sideAdmin

Pedido

Obtém o número restante de vezes que os códigos podem ser usados. Para filtrar os códigos, use o parâmetro de pesquisa codes.

Para configurar o limite de código em si, vá para a seção Admin:

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
Consulta
codes[]Array of strings

Códigos exclusivos que diferenciam maiúsculas de minúsculas. Contém apenas letras e números.

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://xsolla.redocly.app/_mock/pt/api/liveops/v2/project/44056/admin/code/limit/coupon/external_id/coupon_44056_1?codes%5B%5D=string&limit=50&offset=0'

Respostas

Limites de cupom recebidos com sucesso para um código.

Corpoapplication/json
has_moreboolean

Se existir outra página com códigos.

itemsArray of objects(Code-limit-promo-code)
promotion_idinteger

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

total_items_countnumber

Número total de códigos.

Resposta
application/json
{
  "has_more": false,
  "items": [
    { … },
    { … }
  ],
  "promotion_id": 1,
  "total_items_count": 2
}

Ativar promoção de cupomServer-sideAdmin

Pedido

Ativa uma promoção de cupom. A promoção de cupom criada está desabilitada por padrão. Ele não estará pronto para resgate até que você o ative. Use esse ponto de extremidade para habilitar e ativar uma promoção de cupom.

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 PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/liveops/v2/project/44056/admin/coupon/coupon_44056_1/activate

Respostas

O cupom foi ativado com sucesso.

Resposta
Sem conteúdo

Obter códigos de cupomServer-sideAdmin

Pedido

Obtém códigos de cupom.

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
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://xsolla.redocly.app/_mock/pt/api/liveops/v2/project/44056/admin/coupon/coupon_44056_1/code?limit=50&offset=0'

Respostas

Lista de códigos para um cupom recebida com sucesso.

Corpoapplication/json
codesArray of objects
total_countnumber

Contagem total de códigos de cupom.

Resposta
application/json
{
  "codes": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "total_count": 5
}

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

Cliente

Operações