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

Pedido

Exclui uma região específica.

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

ID de região. Identificador de região exclusivo dentro do projeto.

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

Respostas

Região excluída com sucesso.

Corpo
Resposta
Sem conteúdo

Pedido

Obtém região específica.

Você pode usar uma região para gerenciar suas restrições regionais.

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

ID de região. Identificador de região exclusivo dentro do projeto.

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

Respostas

A região especificada foi recebida com sucesso.

Corpoapplication/json
countriesArray of strings(Regions_countries)

Lista de países a serem adicionados em uma região.
Código de país de duas letras maiúsculas de acordo com o padrão ISO 3166-1 alfa-2. Verifique a documentação para obter informações detalhadas sobre os países suportados pela Xsolla.
Exemplo: ["JP", "CN", "VN"]

idinteger(Regions_region_id)

ID de região. Identificador de região exclusivo dentro do projeto.

Exemplo: 42
nameobject(Regions_name)

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

Padrão {"de-DE":"Asien","en-US":"Asia"}
Exemplo: {"de-DE":"Asien","en-US":"Asia"}
Resposta
application/json
{ "value": { "countries": [], "id": 44, "name": {} } }

Pedido

Atualiza uma região específica.

Você pode usar uma região para gerenciar suas restrições regionais.

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

ID de região. Identificador de região exclusivo dentro do projeto.

Exemplo: 42
Corpoapplication/json
countriesArray of strings(Regions_countries)obrigatório

Lista de países a serem adicionados em uma região.
Código de país de duas letras maiúsculas de acordo com o padrão ISO 3166-1 alfa-2. Verifique a documentação para obter informações detalhadas sobre os países suportados pela Xsolla.
Exemplo: ["JP", "CN", "VN"]

nameobject(Regions_name)obrigatório

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

Padrão {"de-DE":"Asien","en-US":"Asia"}
Exemplo: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*stringpropriedade adicional
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/region/42 \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

Respostas

Região atualizada com sucesso.

Corpo
Resposta
Sem conteúdo
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