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

Excluir códigos por IDServer-sideAdmin

Pedido

Exclui todos os códigos por ID de chave de jogo.

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

ID do item.

Exemplo: 656
Consulta
user_emailstringobrigatório

E-mail do usuário.

Exemplo: user_email=email@email.com
reasonstringobrigatório

Razão de recebimento de códigos.

Exemplo: reason=Very important
region_idinteger

ID de região.

Padrão 1
curl -i -X DELETE \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/delete/id/656?user_email=email%40email.com&reason=Very+important&region_id=1'

Respostas

Os códigos foram recebidos com sucesso.

Corpotext/plain
string
Resposta
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

Pedido

Exclui todos os códigos por SKU de chave de jogo.

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
Consulta
user_emailstringobrigatório

E-mail do usuário.

Exemplo: user_email=email@email.com
reasonstringobrigatório

Razão de recebimento de códigos.

Exemplo: reason=Very important
region_idinteger

ID de região.

Padrão 1
curl -i -X DELETE \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/delete/sku/booster_mega_1?user_email=email%40email.com&reason=Very+important&region_id=1'

Respostas

Os códigos foram recebidos com sucesso.

Corpotext/plain
string
Resposta
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

Obter códigos por IDServer-sideAdmin

Pedido

Obtém um certo número de códigos por ID de chave de jogo.

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

ID do item.

Exemplo: 656
Consulta
user_emailstringobrigatório

E-mail do usuário.

Exemplo: user_email=email@email.com
quantityintegerobrigatório

Quantidade de códigos.

Exemplo: quantity=100
reasonstringobrigatório

Razão de recebimento de códigos.

Exemplo: reason=Very important
region_idinteger

ID de região.

Padrão 1
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/request/id/656?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

Respostas

Os códigos foram recebidos com sucesso.

Corpotext/plain
string
Resposta
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3
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

Catálogo

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

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