Saltar para o conteúdo

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

Transferir a descrição da OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/shop-builder/
https://store.xsolla.com/api/
Operações

Catálogo personalizado

Essa API permite especificar regras para atributos de usuário. Se o usuário atender a todas as condições para uma regra concreta, serão exibidos itens personalizados.

Para promoções personalizadas, consulte a seção Promotions.

Para passar atributos antes de uma compra, você pode usar a Xsolla Login API ou passá-los para a propriedade user.attributes ao gerar o token usando a Pay Station API.

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://xsolla.redocly.app/_mock/pt/api/shop-builder/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://xsolla.redocly.app/_mock/pt/api/shop-builder/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
Operações
Operações
Operações

Cupons

Esta API permite que você gerencie cupons.

Operações

Códigos promocionais

Esta API permite gerenciar códigos promocionais.

Operações

Ofertas de catálogo exclusivas

Essa API permite que você gerencie ofertas de catálogo exclusivas.

Operações

Descontos

Esta API permite-lhe gerir promoções de desconto.

Operações

Bônus

Esta API permite gerenciar promoções de bônus.

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