Saltar para o conteúdo

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

Catálogo

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

Operações
Operações
Operações
Operações
Operações
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
Operações
Operações
Operações
Operações

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

Pedido

Obtém o número restante de vezes que o usuário especificado pode usar a promoção dentro do limite aplicado.

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
Consulta
user_external_idstringobrigatório

ID externo de usuário

Exemplo: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425?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 } }

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

Pedido

Aumenta o número restante de vezes que o usuário especificado pode usar a promoção dentro do limite aplicado.

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)>= 1obrigató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 POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/user/limit/promotion/id/111425 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "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 } }

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://xsolla.redocly.app/_mock/pt/api/shop-builder/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 } }
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações
Operações