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

Obter informações sobre as configurações do webhookServer-sideAdmin

Pedido

Obtém as informações sobre as configurações de webhook na Store. Consulte a documentação de webhooks para saber mais.

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
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook

Respostas

As informações sobre as configurações do webhook foram recebidas com sucesso.

Corpoapplication/json
is_enabledboolean
Exemplo: true
secretstring
Exemplo: "my_secret"
urlstring
Exemplo: "http://site.ru/webhook"
Resposta
application/json
{ "is_enabled": true, "secret": "my_secret", "url": "http://site.ru/webhook" }

Atualizar informações sobre as configurações do webhookServer-sideAdmin

Pedido

Atualiza as informações sobre as configurações de webhook na Store. Consulte a documentação de webhooks para saber mais.

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/jsonobrigatório

Informações sobre configurações de webhook.

is_enabledbooleanobrigatório

Se os webhooks de Serviços de Jogos estiverem ativados.

Para webhooks de Serviços de Jogos, a configuração especificada nesta chamada API tem precedência sobre a configuração definida na Conta de Distribuidor na seção Configurações do projeto > webhooks.

Exemplo: true
secretstringobrigatório

A chave secreta do projeto para assinar webhooks de Serviços de Jogos.

Para Serviços de Jogos, a chave especificada nesta chamada API tem precedência sobre a chave gerada na Conta de Distribuidor na seção Configurações do projeto > Webhooks.

Exemplo: "my_secret_key"
urlstringobrigatório

URL do seu servidor para receber webhooks de Serviços de Jogos. O URL deve ser publicamente acessível utilizando o protocolo HTTPS, como https://example.com. Você também pode especificar o URL que encontrar em qualquer ferramenta para testar webhooks.

Para webhooks de Serviços de Jogos, a configuração especificada nesta chamada API tem precedência sobre a configuração definida na Conta de Distribuidor na seção Configurações do projeto > webhooks.

Exemplo: "http://site.ru/webhook"
versioninteger

Versão de webhooks. Na versão 2, a matriz de itens inclui os parâmetros is_free, is_bonus, e is_bundle_content, que não estão presentes na versão 1 (padrão).

Enum12
Exemplo: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "secret": "my_secret_key",
    "url": "http://site.ru/webhook",
    "version": 1
  }'

Respostas

As informações sobre as configurações do webhook foram atualizadas com sucesso.

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