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

Preencher o carrinho com itensServer-side

Pedido

Preenche o carrinho atual com itens. Se o carrinho já tiver um item com o mesmo SKU, o item existente será substituído pelo valor passado.

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
localestring

Linguagem de resposta. Código de idioma minúsculo de duas letras de acordo com o padrão ISO 639-1.

Padrão "en"
Cabeçalhos
x-user-forstring

O identificador do usuário pode ser transferido usando o Xsolla Login User JWT ou o token de acesso Pay Station.

Exemplo: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Você pode usar seu próprio ID de usuário ao vender um carrinho com jogos.

Exemplo: UNIQUE_ID
Corpoapplication/json
countrystring= 2 characters

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: country=US

Exemplo: "US"
currencystring= 3 characters

A moeda do preço do item exibida no carrinho. Código 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.

Exemplo: "USD"
itemsArray of objectsnon-emptyobrigatório
items[].​quantitynumber>= 1obrigatório

Quantidade do item.

Exemplo: 2
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"
curl -i -X PUT \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/admin/project/44056/cart/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "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"
      }
    ]
  }'

Respostas

O carrinho com itens foi devolvido com sucesso.

Corpoapplication/json
cart_idstring

ID do carrinho. Passe-o para consulta da página de compra ou os pontos de extremidade da API de pagamento.

Exemplo: "cart_id"
is_freeboolean(value-cart_is_free)

Se true, o carrinho é gratuito.

Padrão false
Exemplo: false
itemsArray of objects
priceobject or null

Preço do carrinho.

promotionsArray of objects(Catalog_cart_promotions)

Promoções aplicadas para todo o carrinho. A matriz é retornada nos seguintes casos:

  • Uma promoção afeta o valor total do carrinho, como um código promocional com a configuração Desconto na compra.

  • Uma promoção adiciona itens bônus ao carrinho.

Se nenhuma promoção no nível do pedido for aplicada, é retornada uma matriz vazia.

warningsArray of objects
Resposta
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {}, {}, {} ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }

Preencha o ID do carrinho pelo carrinho com itensServer-side

Pedido

Preenche o carrinho por ID de carrinho com itens. Se o carrinho já tiver um item com o mesmo SKU, o item existente será substituído pelo valor passado.

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

ID do carrinho.

Exemplo: custom_id
Consulta
localestring

Linguagem de resposta. Código de idioma minúsculo de duas letras de acordo com o padrão ISO 639-1.

Padrão "en"
Cabeçalhos
x-user-forstring

O identificador do usuário pode ser transferido usando o Xsolla Login User JWT ou o token de acesso Pay Station.

Exemplo: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Você pode usar seu próprio ID de usuário ao vender um carrinho com jogos.

Exemplo: UNIQUE_ID
Corpoapplication/json
countrystring= 2 characters

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: country=US

Exemplo: "US"
currencystring= 3 characters

A moeda do preço do item exibida no carrinho. Código 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.

Exemplo: "USD"
itemsArray of objectsnon-emptyobrigatório
items[].​quantitynumber>= 1obrigatório

Quantidade do item.

Exemplo: 2
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"
curl -i -X PUT \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/admin/project/44056/cart/custom_id/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "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"
      }
    ]
  }'

Respostas

O carrinho com itens foi devolvido com sucesso.

Corpoapplication/json
cart_idstring

ID do carrinho. Passe-o para consulta da página de compra ou os pontos de extremidade da API de pagamento.

Exemplo: "cart_id"
is_freeboolean(value-cart_is_free)

Se true, o carrinho é gratuito.

Padrão false
Exemplo: false
itemsArray of objects
priceobject or null

Preço do carrinho.

promotionsArray of objects(Catalog_cart_promotions)

Promoções aplicadas para todo o carrinho. A matriz é retornada nos seguintes casos:

  • Uma promoção afeta o valor total do carrinho, como um código promocional com a configuração Desconto na compra.

  • Uma promoção adiciona itens bônus ao carrinho.

Se nenhuma promoção no nível do pedido for aplicada, é retornada uma matriz vazia.

warningsArray of objects
Resposta
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {}, {}, {} ], "price": { "amount": "15.97", "amount_without_discount": "22.96", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }
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