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

Obter lista de atributos (admin)Server-sideAdmin

Pedido

Obtém a lista de atributos de um projeto para administração.

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

Respostas

Lista de atributos recebida com sucesso.

Corpoapplication/json
attributesArray of objects(admin_attribute_response)
Exemplo: [{"value":[{"external_id":"genre","name":{"de":"Genre","en":"Genre"}}]}]
total_countinteger
Resposta
application/json
{ "attributes": [ {}, {} ], "total_count": 2 }

Pedido

Cria um atributo.

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
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$obrigatório

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

Exemplo: "attribute_1"
nameobject(admin-attribute-name)obrigatório

Objeto com localizações para o nome do atributo. As chaves são especificadas no formato ISO 3166-1.

Padrão {"de":"Genre","en":"Genre"}
Exemplo: {"de":"Genre","en":"Genre"}
name.​property name*stringpropriedade adicional
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/attribute \
  -H 'Content-Type: application/json' \
  -d '{
    "external_id": "genre",
    "name": {
      "de": "Genre",
      "en": "Genre"
    }
  }'

Respostas

O atributo foi criado com sucesso.

Corpoapplication/json
external_idstring(admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

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

Exemplo: "attribute_1"
Resposta
application/json
{ "external_id": "genre" }

Pedido

Exclui um atributo.

Aviso

Se você excluir um atributo de item, todos os seus dados e conexões com itens serão perdidos.
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_idstringobrigatório

ID externo de atributo.

Exemplo: attribute_id
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/attribute/attribute_id

Respostas

Atributo excluído com sucesso.

Resposta
Sem conteúdo

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