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
Operações
Operações
Operações
Operações
Operações
Operações

Definir o limite de pré-venda da quantidade de itemServer-sideAdmin

Pedido

Defina a quantidade do limite de pré-venda do item.

A API Pre-Order limit permite que você venda um item em uma quantidade limitada. Para configurar a pré-venda em si, vá para a seção Admin do módulo do item desejado:

Aliases para este ponto de extremidade:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}
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
Corpoapplication/json
quantityintegerobrigatório

Quantidade a definir.

curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 100000
  }'

Respostas

A quantidade a ser limitada foi definida com sucesso.

Resposta
Sem conteúdo

Remover toda a quantidade de limite de pré-venda do itemServer-sideAdmin

Pedido

Remova o limite de pré-venda do item.

A API Pre-Order limit permite que você venda um item em uma quantidade limitada. Para configurar a pré-venda em si, vá para a seção admin do módulo do item desejado:

Aliases para este ponto de extremidade:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/all
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
curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1/all

Respostas

O limite foi removido com êxito.

Resposta
Sem conteúdo

Alternar o limite de pré-venda do itemServer-sideAdmin

Pedido

Ative/desative o limite de pré-venda do item.

A API Pre-Order limit permite que você venda um item em uma quantidade limitada. Para configurar a pré-venda em si, vá para a seção admin do módulo do item desejado:

Aliases para este ponto de extremidade:

  • /v2/project/{project_id}/admin/items/pre_order/limit/item/id/{item_id}/toggle
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
Corpoapplication/json
is_pre_order_limit_enabledbooleanobrigatório
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/items/pre_order/limit/item/sku/booster_mega_1/toggle \
  -H 'Content-Type: application/json' \
  -d '{
    "is_pre_order_limit_enabled": true
  }'

Respostas

O limite foi desabilitado/habilitado.

Resposta
Sem conteúdo
Operações

Catálogo

Esta API permite obter qualquer tipo de itens vendáveis ou itens específicos.

Operações
Operações
Operações