Saltar para o conteúdo
/
Defina o número de itens...

Catalog API (2.0.0)

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

Catalog API fornece endpoints para gerenciar o catálogo da sua loja no jogo e processar compras. Use os endpoints para configurar itens virtuais, moedas virtuais, chaves do jogo, conjuntos, fluxos de carrinho e pagamento, atributos de itens e importar itens de fontes externas.

Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/catalog/
https://store.xsolla.com/api/

Admin

Operações

Catálogo

Operações

Pagamento virtual

Operações

Catálogo

Operações

Direito

Operações

Admin

Operações

Admin

Operações

Catálogo

Operações

Carrinho (lado do cliente)

Operações

Carrinho (lado do servidor)

Operações

Pagamento (lado do cliente)

Operações

Pagamento (lado do servidor)

Operações

Pedido

Operações

Itens gratuitos

Operações

Gestão

Operações

Aumente o número de itens disponíveis para o usuário especificadoServer-sideAdmin

Pedido

Aumenta o número restante de itens disponíveis para o usuário especificado dentro do limite aplicado.

A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado:

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
availableinteger(User-limit_available)>= 1obrigatório

Número restante de itens ou usos da promoção disponíveis para o usuário dentro do limite aplicado.

userobject(User-limit_user)obrigatório
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$obrigatório

ID de usuário externo.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respostas

Os limites de compra para um usuário foram recebidos com sucesso.

Corpoapplication/json
per_userobject
Resposta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Defina o número de itens disponíveis para o usuário especificadoServer-sideAdmin

Pedido

Define o número de itens que o usuário especificado pode comprar dentro do limite aplicado depois que ele foi aumentado ou diminuído.

A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado:

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
availableinteger(User-limit_available_flexible)>= 0obrigatório

Número restante de itens ou usos da promoção disponíveis para o usuário dentro do limite aplicado.

userobject(User-limit_user)obrigatório
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$obrigatório

ID de usuário externo.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 0,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respostas

Os limites de compra para um usuário foram recebidos com sucesso.

Corpoapplication/json
per_userobject
Resposta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Atualizar limite de compraServer-sideAdmin

Pedido

Atualiza o limite de compra de um item para que um usuário possa comprá-lo novamente. Se o parâmetro user for null, essa chamada atualizará esse limite para todos os usuários.

A API User limit permite que você venda um item em uma quantidade limitada. Para configurar os limites de compra, vá para a seção Admin do módulo de tipo de item desejado:

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
userobject or null(User-limit_user_flexible)obrigatório
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$

ID de usuário externo.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respostas

O limite foi atualizado com sucesso.

Resposta
Sem conteúdo

Admin

Operações

Webhooks

Operações

Reservas

Operações

Comerciante

Operações

Catálogo

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

Operações

Regiões comuns

Operações

Admin

Operações