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

Catalog API fornece endpoints para gerenciar o catálogo da sua loja no jogo e processar compras. Use os endpoints para configurar itens virtuais, moedas virtuais, chaves do jogo, conjuntos, fluxos de carrinho e pagamento, atributos de itens e importar itens de fontes externas.

Transferir a descrição da OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/catalog/
https://store.xsolla.com/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
Operações
Operações

Criar pedido com carrinho gratuito específicoClient-side

Pedido

Cria um pedido com todos os itens do carrinho gratuito específico. O pedido criado receberá um status de pedido done.

Segurança
AuthForCart
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
cart_idstringobrigatório

ID do carrinho.

Exemplo: custom_id
Corpoapplication/json
currencystring

Moeda do preço do pedido. Código de moeda de três letras de acordo com a ISO 4217. Consulte a documentação para obter informações detalhadas sobre as moedas suportadas pelo Xsolla.

custom_parametersobject[ 1 .. 200 ] properties

Parâmetros específicos do projeto.

localestring

Idioma de resposta.

sandboxboolean

Cria um pedido no modo sandbox. A opção está disponível para os usuários especificados na lista de usuários da empresa.

Padrão false
settingsobject

As configurações para instalar o processo de pagamento e a interface de pagamento para um usuário.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/44056/free/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Respostas

O pedido grátis foi criado com sucesso.

Corpoapplication/json
order_idinteger

ID de pedido.

Resposta
application/json
{ "order_id": 641 }

Criar pedido com item gratuito especificadoClient-side

Pedido

Cria um pedido com um item livre especificado. O pedido criado receberá um status de pedido done.

Segurança
XsollaLoginUserJWT
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
Corpoapplication/json
currencystring

Moeda do preço do pedido. Código de moeda de três letras de acordo com a ISO 4217. Consulte a documentação para obter informações detalhadas sobre as moedas suportadas pelo Xsolla.

custom_parametersobject[ 1 .. 200 ] properties

Parâmetros específicos do projeto.

localestring

Idioma de resposta.

promo_codestring

Resgata um código de uma promoção de código promocional com pagamento.

quantityinteger>= 1

Quantidade do item.

Padrão 1
sandboxboolean

Cria um pedido no modo sandbox. A opção está disponível para os usuários especificados na lista de usuários da empresa.

Padrão false
settingsobject

As configurações para instalar o processo de pagamento e a interface de pagamento para um usuário.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/44056/free/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "promo_code": "discount_code",
    "quantity": 5,
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

Respostas

O pedido grátis foi criado com sucesso.

Corpoapplication/json
order_idinteger

ID de pedido.

Resposta
application/json
{ "order_id": 641 }
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