Saltar para o conteúdo

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

Preencher o carrinho com itensServer-side

Pedido

Preenche o carrinho atual com itens. Se o carrinho já tiver um item com o mesmo SKU, o item existente será substituído pelo valor passado.

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
Consulta
localestring

Linguagem de resposta. Código de idioma minúsculo de duas letras de acordo com o padrão ISO 639-1.

Padrão "en"
Cabeçalhos
x-user-forstring

O identificador do usuário pode ser transferido usando o Xsolla Login User JWT ou o token de acesso Pay Station.

Exemplo: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Você pode usar seu próprio ID de usuário ao vender um carrinho com jogos.

Exemplo: UNIQUE_ID
Corpoapplication/json
countrystring= 2 characters

Código de país de duas letras maiúsculas de acordo com o padrão ISO 3166-1 alfa-2. Verifique a documentação para obter informações detalhadas sobre os países suportados pela Xsolla.
Exemplo: country=US

Exemplo: "US"
currencystring= 3 characters

A moeda do preço do item exibida no carrinho. Código de três letras de acordo com a ISO 4217. Consulte a documentação para obter informações detalhadas sobre as moedas suportadas pelo Xsolla.

Exemplo: "USD"
itemsArray of objectsnon-emptyobrigatório
items[].​quantitynumber>= 1obrigatório

Quantidade do item.

Exemplo: 2
items[].​skustringnon-emptyobrigatório

ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.

Exemplo: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/catalog/v2/admin/project/44056/cart/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Respostas

O carrinho com itens foi devolvido com sucesso.

Corpoapplication/json
cart_idstring

ID do carrinho. Passe-o para consulta da página de compra ou os pontos de extremidade da API de pagamento.

Exemplo: "cart_id"
is_freeboolean(value-cart_is_free)

Se true, o carrinho é gratuito.

Padrão false
Exemplo: false
itemsArray of objects
priceobject or null

Preço do carrinho.

promotionsArray of objects(Catalog_cart_promotions)

Promoções aplicadas para todo o carrinho. A matriz é retornada nos seguintes casos:

  • Uma promoção afeta o valor total do carrinho, como um código promocional com a configuração Desconto na compra.

  • Uma promoção adiciona itens bônus ao carrinho.

Se nenhuma promoção no nível do pedido for aplicada, é retornada uma matriz vazia.

warningsArray of objects
Resposta
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … },
    { … },
    { … }
  ],
  "price": {
    "amount": "15.97",
    "amount_without_discount": "22.96",
    "currency": "USD"
  },
  "promotions": [
    { … }
  ],
  "warnings": [
    { … }
  ]
}

Preencha o ID do carrinho pelo carrinho com itensServer-side

Pedido

Preenche o carrinho por ID de carrinho com itens. Se o carrinho já tiver um item com o mesmo SKU, o item existente será substituído pelo valor passado.

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

ID do carrinho.

Exemplo: custom_id
Consulta
localestring

Linguagem de resposta. Código de idioma minúsculo de duas letras de acordo com o padrão ISO 639-1.

Padrão "en"
Cabeçalhos
x-user-forstring

O identificador do usuário pode ser transferido usando o Xsolla Login User JWT ou o token de acesso Pay Station.

Exemplo: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Você pode usar seu próprio ID de usuário ao vender um carrinho com jogos.

Exemplo: UNIQUE_ID
Corpoapplication/json
countrystring= 2 characters

Código de país de duas letras maiúsculas de acordo com o padrão ISO 3166-1 alfa-2. Verifique a documentação para obter informações detalhadas sobre os países suportados pela Xsolla.
Exemplo: country=US

Exemplo: "US"
currencystring= 3 characters

A moeda do preço do item exibida no carrinho. Código de três letras de acordo com a ISO 4217. Consulte a documentação para obter informações detalhadas sobre as moedas suportadas pelo Xsolla.

Exemplo: "USD"
itemsArray of objectsnon-emptyobrigatório
items[].​quantitynumber>= 1obrigatório

Quantidade do item.

Exemplo: 2
items[].​skustringnon-emptyobrigatório

ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.

Exemplo: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/pt/api/catalog/v2/admin/project/44056/cart/custom_id/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Respostas

O carrinho com itens foi devolvido com sucesso.

Corpoapplication/json
cart_idstring

ID do carrinho. Passe-o para consulta da página de compra ou os pontos de extremidade da API de pagamento.

Exemplo: "cart_id"
is_freeboolean(value-cart_is_free)

Se true, o carrinho é gratuito.

Padrão false
Exemplo: false
itemsArray of objects
priceobject or null

Preço do carrinho.

promotionsArray of objects(Catalog_cart_promotions)

Promoções aplicadas para todo o carrinho. A matriz é retornada nos seguintes casos:

  • Uma promoção afeta o valor total do carrinho, como um código promocional com a configuração Desconto na compra.

  • Uma promoção adiciona itens bônus ao carrinho.

Se nenhuma promoção no nível do pedido for aplicada, é retornada uma matriz vazia.

warningsArray of objects
Resposta
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … },
    { … },
    { … }
  ],
  "price": {
    "amount": "15.97",
    "amount_without_discount": "22.96",
    "currency": "USD"
  },
  "promotions": [
    { … }
  ],
  "warnings": [
    { … }
  ]
}

Pagamento (lado do cliente)

Operações

Pagamento (lado do servidor)

Operações

Pedido

Operações

Itens gratuitos

Operações

Gestão

Operações

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