Saltar para o conteúdo

Visão geral

  • Versão: 2.0.0
  • Servidores: https://store.xsolla.com/api
  • Contate-nos por e-mail
  • URL de contato: https://xsolla.com/
  • Versão TLS necessária: 1.2

A Catalog API permite que você configure um catálogo de itens de jogo no lado da Xsolla e exibir o catálogo aos usuários na sua loja.

A API permite que você gerencie as seguintes entidades de catálogo:

  • Itens virtuais — itens de jogo tais como armas, visuais e reforços.
  • Moedas virtuais — dinheiro virtual utilizado para comprar bens virtuais.
  • Pacotes de moedas virtuais — conjuntos pré-definidos de moedas virtuais.
  • Conjuntos — pacotes combinados de itens virtuais, moedas ou chaves de jogo vendidas como um único SKU.
  • Chaves de jogo — chaves para jogos e DLCs distribuídos via plataformas como o Steam ou outros provedores de DRM.
  • Grupos — agrupamentos lógicos para organizar e filtrar itens dentro do catálogo.

Chamadas de API

A API divide-se nos seguintes grupos:

  • Admin — chamadas para criar, atualizar, excluir e configurar itens de catálogo e grupos. Autenticada via autenticação de acesso básica com seu comerciante ou credenciais do projeto. Não se destina a uso em vitrines.
  • Catalog — chamadas para recuperar itens e construir vitrines personalizadas para usuários finais. Desenvolvida para gerenciar cenários de carga alta. Suporta a autorização opcional de JWT de usuários para retornar dados personalizados, tais como limites específicos aos usuários e promoções ativas.
Transferir a descrição da OpenAPI
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/catalog/
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 token de pagamento para compraServer-side

Pedido

Gera um pedido e um token de pagamento para ele. O pedido é gerado com base nos itens passados no corpo da solicitação.

Para abrir a interface de pagamento em uma nova janela, use o seguinte link: https://secure.xsolla.com/paystation4/?token={token}, onde {token} é o token recebido.

Para propósitos de teste, use este URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Aviso

O parâmetro user.country.value é usado para selecionar uma moeda para o pedido. Se o país do usuário é desconhecido, fornecer o IP do usuário no cabeçalho X-User-Ip é uma opção alternativa.
Uma dessas duas opções é necessária para o trabalho correto desse método.
A moeda selecionada é usada para métodos de pagamento no Pay Station.
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
custom_parametersobject or null(Cart-Payment_custom_parameters_token)[ 1 .. 200 ] properties

Seus parâmetros personalizados representados como um conjunto JSON válido de pares chave-valor.
Você pode passar parâmetros adicionais por esse campo para configurar filtros antifraude. Consulte a documentação do Pay Station.

Exemplo: {"custom_parameters":{"bool_param":true,"int_param":100,"null_param":null,"number_param":12.5,"string_param":"example"}}
promo_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

Código exclusivo que diferencia maiúsculas de minúsculas. Contém letras e números.

Padrão "WINTER2021"
Exemplo: "WINTER2021"
purchaseobject(Cart_admin_payment)obrigatório
purchase.​itemsArray of objectsnon-emptyobrigatório
purchase.​items[].​quantitynumber>= 1obrigatório

Quantidade do item.

Exemplo: 2
purchase.​items[].​skustringnon-emptyobrigatório

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

Exemplo: "t-shirt"
sandboxboolean(Cart-Payment_settings_sandbox)

Defina como true para testar o processo de pagamento. Nesse caso, use https://sandbox-secure.xsolla.com para acessar a interface de pagamento de teste.

Padrão false
settingsobject

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

userobject(Cart-Payment_admin-user-request-body)obrigatório
user.​ageinteger

Idade do usuário.

user.​countryobject
user.​emailobject
user.​idobjectobrigatório
user.​id.​valuestring[ 1 .. 255 ] characters

ID do usuário. Para teste, você pode passar qualquer valor. Para aceitar pagamentos reais, você precisa usar o valor do ID do usuário do seu sistema. Esse ID é passado no webhook User validation.

user.​is_legalboolean

Se o usuário é uma entidade legal.

user.​legalobject

Objeto com dados da entidade legal. O objeto e todos os seus parâmetros são necessários se user.is_legal for true.

user.​nameobject
user.​phoneobject
user.​steam_idobject
user.​tracking_idobject
curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v3/project/44056/admin/payment/token \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "items": [
        {
          "quantity": 2,
          "sku": "com.xsolla.cup01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.t-shirt01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.cup02"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.hat01"
        }
      ]
    },
    "settings": {
      "currency": "USD",
      "external_id": "AABBCCDD01",
      "language": "de",
      "payment_method": 1380,
      "return_url": "https://developers.xsolla.com/pt/",
      "ui": {
        "theme": "63295aab2e47fab76f7708e3"
      }
    },
    "user": {
      "country": {
        "allow_modify": false,
        "value": "US"
      },
      "email": {
        "value": "user@xsolla.com"
      },
      "id": {
        "value": "user-id"
      },
      "name": {
        "value": "user-name"
      }
    }
  }'

Respostas

Token de pagamento e pedido criados com sucesso.

Corpoapplication/json
order_idinteger

ID de pedido.

Exemplo: 1
tokenstring

Token de pagamento.

Resposta
application/json
{ "order_id": 12345, "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb" }
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