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

Excluir todos os itens do carrinho pelo ID de carrinhoClient-side

Pedido

Exclui todos os itens do carrinho.

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
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/cart/custom_id/clear \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

O carrinho foi liberado com sucesso.

Preencha o carrinho específico com itensClient-side

Pedido

Preenche o carrinho específico com itens. Se o carrinho já tiver um item com o mesmo SKU, a posição do item existente será substituída pelo valor passado.

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
itemsArray of objectsobrigatório

Lista de itens.

Exemplo: [{"quantity":123,"sku":"com.xsolla.booster_mega_1"}]
items[].​quantitynumberobrigatório
Padrão 123
items[].​skustringobrigatório
Padrão "booster_mega_1"
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/cart/custom_id/fill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "quantity": 123,
        "sku": "com.xsolla.booster_mega_1"
      }
    ]
  }'

Respostas

O carrinho com itens foi devolvido com sucesso.

Corpoapplication/json
cart_idstring

ID do carrinho.

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.

Exemplo: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
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": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }

Excluir item de carrinho por ID de carrinhoClient-side

Pedido

Remove um item do carrinho.

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

SKU do item.

Exemplo: booster_mega_1
curl -i -X DELETE \
  https://store.xsolla.com/api/v2/project/44056/cart/custom_id/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

O item do carrinho foi excluído com sucesso.

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