Saltar para o conteúdo

API Shop Builder (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

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
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/shop-builder/
https://store.xsolla.com/api/

Admin

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

Obter lista de regras de filtro de catálogoServer-sideAdmin

Pedido

Obtém todas as regras aplicadas aos atributos do usuário.

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
is_enabledinteger

Filtrar elementos pela flag is_enabled.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/user/attribute/rule?limit=50&offset=0&is_enabled=0'

Respostas

As regras foram recebidas com sucesso.

Corpoapplication/json
has_moreboolean

Se existir outra página com regras.

itemsArray of objects(user-attribute_personalized-catalog)
total_items_countnumber

Número total de regras.

Resposta
application/json
{
  "has_more": true,
  "items": [
    { … }
  ],
  "total_items_count": 20
}

Criar regra de filtro de catálogoServer-sideAdmin

Pedido

Criar regra para atributos de usuário.

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
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = data (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] itemsobrigatório

Condições para validação de atributos do usuário. Determine a disponibilidade do item no catálogo com base em se os atributos do usuário correspondem a todas as condições especificadas.

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$obrigatório

Código de atributo do usuário.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

Indica que a condição é atendida mesmo se o atributo estiver ausente dos atributos do usuário. Passe true para mostrar o item aos usuários que não têm esse atributo. Os usuários que têm o atributo, mas o valor não corresponder ao especificado na condição, não verão o item. false — os usuários que têm o atributo, mas o valor não corresponder ao especificado na condição, ou o atributo estiver ausente, não verão o item.

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)obrigatório

Tipo de operação realizada por condição. Para o tipo de atributo string.

Enum ValorDescrição
eq

Iguais

ne

Diferentes

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)obrigatório

Tipo de atributo de usuário.

Valor"string"
attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 charactersobrigatório

Valor da condição com o qual o valor do atributo do usuário será comparado. O tipo depende do tipo de atributo.

is_enabledbooleanobrigatório

Se a regra estiver habilitada.

is_satisfied_for_unauthboolean

Se o item é exibido para usuários não autorizados. Se true, o item será exibido para o usuário não autorizado, independentemente das regras de exibição do catálogo. false por padrão.

itemsArray of objects[ 1 .. 100 ] itemsobrigatório
One of:

Itens que são mostrados a um usuário se seus valores de atributo atenderem às condições.

items[].​item_idnumberobrigatório

ID do item.

namestring[ 1 .. 255 ] characters^\Sobrigatório

Nome legível de uma regra. Usado para exibir uma regra na Conta de Distribuidor.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/user/attribute/rule \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "ork"
      }
    ],
    "is_enabled": true,
    "is_satisfied_for_unauth": false,
    "items": [
      {
        "item_id": 1
      }
    ],
    "name": "Ork race armor rule"
  }'

Respostas

Regra criada com sucesso.

Corpoapplication/json
rule_idnumber

ID da regra.

Resposta
application/json
{
  "rule_id": 1
}

Obter todas as regras de catálogo para pesquisa no lado do clienteServer-sideAdmin

Pedido

Obtém uma lista de todas as regras de catálogo para pesquisa no lado do cliente.

Atenção

Retorna apenas ID de regra, nome e is_enabled
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
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/user/attribute/rule/all

Respostas

As regras foram recebidas com sucesso.

Corpoapplication/json
itemsArray of objects(user-attribute_personalized-catalog_all)
Resposta
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Admin

Operações

Catálogo

Operações

Carrinho (lado do cliente)

Operações

Carrinho (lado do servidor)

Operações

Pagamento (lado do cliente)

Operações

Pagamento (lado do servidor)

Operações

Pedido

Operações

Itens gratuitos

Operações

Webhooks

Operações

Reservas

Operações

Comerciante

Operações

Catálogo

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

Operações

Regiões comuns

Operações

Catálogo

Operações

Direito

Operações

Admin

Operações

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

Admin

Operações

Catálogo

Operações

Pagamento virtual

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

Admin

Operações