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

Carregar códigos por IDServer-sideAdmin

Pedido

Carrega códigos por ID de chave de jogo.

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

ID do item.

Exemplo: 656
Corpomultipart/form-data
filestring(binary)obrigatório

Arquivo com códigos.

Exemplo: "keys.txt"
region_idinteger

ID de região.

Exemplo: 1
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/items/game/key/upload/id/656 \
  -H 'Content-Type: multipart/form-data' \
  -F file=keys.txt \
  -F region_id=1

Respostas

As informações da sessão de carregamento de códigos foram recebidas com sucesso.

Corpoapplication/json
count_skippedinteger
Exemplo: 10
count_totalinteger
Exemplo: 100
count_uploadedinteger
Exemplo: 0
session_idstring
Exemplo: "fc7105b6e8ee01339582970b37697242"
statusstring
Exemplo: "processing"
Resposta
application/json
{ "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" }

Obter códigos carregando informações da sessãoServer-sideAdmin

Pedido

Obtém códigos carregando informações de sessã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
session_idstringobrigatório

ID da sessão.

Padrão "fc7105b6e8ee01339582970b37697242"
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/items/game/key/upload/session/{session_id}'

Respostas

As informações da sessão de carregamento de códigos foram recebidas com sucesso.

Corpoapplication/json
count_skippedinteger
Exemplo: 10
count_totalinteger
Exemplo: 100
count_uploadedinteger
Exemplo: 0
session_idstring
Exemplo: "fc7105b6e8ee01339582970b37697242"
statusstring
Exemplo: "processing"
Resposta
application/json
{ "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" }

Pedido

Carrega códigos por SKU de chave de jogo.

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

SKU do item.

Exemplo: booster_mega_1
Corpomultipart/form-dataobrigatório
filestring(binary)obrigatório

Arquivo com códigos.

Exemplo: "keys.txt"
region_idinteger

ID de região.

Exemplo: 1
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/shop-builder/v2/project/44056/admin/items/game/key/upload/sku/booster_mega_1 \
  -H 'Content-Type: multipart/form-data' \
  -F file=keys.txt \
  -F region_id=1

Respostas

As informações da sessão de carregamento de códigos foram recebidas com sucesso.

Corpoapplication/json
count_skippedinteger
Exemplo: 10
count_totalinteger
Exemplo: 100
count_uploadedinteger
Exemplo: 0
session_idstring
Exemplo: "fc7105b6e8ee01339582970b37697242"
statusstring
Exemplo: "processing"
Resposta
application/json
{ "count_skipped": 10, "count_total": 100, "count_uploaded": 0, "session_id": "fc7105b6e8ee01339582970b37697242", "status": "processing" }
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