SKU de conjunto.
- Obter lista de pacotes por grupo especificado
Obter lista de pacotes
Obter pacote especificado
Obter lista de pacotes po...
Catalog API (2.0.0)
- Versão: 2.0.0
- Servidores:
https://store.xsolla.com/api - Entre em contato por e-mail
- URL de Contato: https://xsolla.com/
- Versão TLS requerida: 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.
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.
Chamadas de API requerem autenticação em nome de um usuário ou de um projeto. O esquema de autenticação utilizado é especificado na seção Segurança na descrição de cada chamada.
A autenticação JWT do usuário é usada quando uma solicitação é enviada de um navegador, aplicativo móvel ou jogo. Por padrão, o esquema XsollaLoginUserJWT é aplicado. Para detalhes sobre como criar um token, consulte a documentação Xsolla Login API.
O token é passado no cabeçalho Authorization no seguinte formato: Authorization: Bearer <user_JWT>, onde <user_JWT> é o token do usuário. O token identifica o usuário e fornece acesso a dados personalizados.
Alternativamente, você pode usar um token para abrir a interface de pagamento.
A autenticação HTTP básica é usada para interações de servidor para servidor, quando uma chamada de API é enviada diretamente do seu servidor em vez de um navegador ou aplicativo móvel do usuário. A autenticação HTTP básica com uma chave de API normalmente é utilizada.
Nota
A chave API é confidencial e não deve ser armazenada ou usada em aplicativos de usuários finais.
A chave API é confidencial e não deve ser armazenada ou usada em aplicativos de usuários finais.
Com a autenticação básica do lado do servidor, todas as solicitações de API devem incluir o seguinte cabeçalho:
- para
basicAuth—Authorization: Basic <your_authorization_basic_key>, ondeyour_authorization_basic_keyé o parproject_id:api_keycodificado em Base64 - para
basicMerchantAuth—Authorization: Basic <your_authorization_basic_key>, ondeyour_authorization_basic_keyé o parmerchant_id:api_keycodificado em Base64
Você pode encontrar os valores dos parâmetros em Conta de Distribuidor:
merchant_idé exibido:- Em Configurações da empresa > Empresa.
- No URL na barra de endereço do navegador em qualquer página da Conta de Distribuidor. O URL tem o seguinte formato:
https://publisher.xsolla.com/<merchant_id>.
project_idé exibido:- Ao lado do nome do projeto na Conta de Distribuidor.
- No URL na barra de endereço do navegador ao trabalhar em um projeto na Conta de Distribuidor. O URL tem o seguinte formato:
https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
api_keyé mostrado na Conta de Distribuidor apenas no momento da criação e deve ser armazenado de forma segura do seu lado. Você pode criar uma chave de API nas seguintes seções:
Aviso
Se uma chamada de API necessária não incluir o parâmetro de caminho
Se uma chamada de API necessária não incluir o parâmetro de caminho
project_id, use uma chave de API que seja válida para todos os projetos da empresa para autorização.Para mais informações sobre como trabalhar com chaves API, consulte as referências de API.
O esquema de autenticação AuthForCart é utilizado para as compras de carrinhos e suporta dois modos:
Autenticação com o JWT do usuário. O token é passado no cabeçalho
Authorizationno seguinte formato:Authorization: Bearer <user_JWT>, onde<user_JWT>é o token do usuário. O token identifica o usuário e fornece acesso a dados personalizados. Alternativamente, você pode usar um token para abrir a interface de pagamento.Modo simplificado sem o cabeçalho Authorization. Esse modo é usado apenas para usuários não autorizados e pode ser aplicado apenas para vendas de chaves de jogo. Em vez de um token, a solicitação deve incluir os seguintes cabeçalhos:
x-unauthorized-idcom um ID de solicitaçãox-usercom o endereço de e-mail do usuário codificado em Base64
Itens de todos os tipos (itens virtuais, pacotes, moeda virtual e chaves) usam uma estrutura de dados semelhante. Compreender a estrutura básica simplifica o trabalho com a API e ajuda a navegar na documentação com mais facilidade.
Nota
Algumas chamadas podem incluir campos adicionais, mas eles não alteram a estrutura básica.
Algumas chamadas podem incluir campos adicionais, mas eles não alteram a estrutura básica.
Identificação
merchant_id— ID da empresa na Conta de Distribuidorproject_id— ID do projeto na Conta de Distribuidorsku— SKU do item, único dentro do projeto
Exibição na loja
name— nome do itemdescription— descrição do itemimage_url— URL da imagemis_enabled— disponibilidade do itemis_show_in_store— se o item é exibido no catálogo
Para mais informações sobre como gerenciar a disponibilidade de itens no catálogo, consulte a documentação.
Organização
type— tipo de item, por exemplo, um item virtual (virtual_item) ou conjunto (bundle)groups— grupos aos quais o item pertenceorder— ordem de exibição no catálogo
Condições de venda
prices— preços em moeda real ou virtuallimits— limites de compraperiods— períodos de disponibilidaderegions— restrições regionais
Exemplo de estrutura da entidade principal:
{
"attributes": [],
"bundle_type": "virtual_currency_package",
"content": [
{
"description": {
"en": "Main in-game currency"
},
"image_url": "https://.../image.png",
"name": {
"en": "Crystals",
"de": "Kristalle"
},
"quantity": 500,
"sku": "com.xsolla.crystal_2",
"type": "virtual_currency"
}
],
"description": {
"en": "Crystals x500"
},
"groups": [],
"image_url": "https://.../image.png",
"is_enabled": true,
"is_free": false,
"is_show_in_store": true,
"limits": {
"per_item": null,
"per_user": null,
"recurrent_schedule": null
},
"long_description": null,
"media_list": [],
"name": {
"en": "Medium crystal pack"
},
"order": 1,
"periods": [
{
"date_from": null,
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [
{
"amount": 20,
"country_iso": "US",
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"regions": [],
"sku": "com.xsolla.crystal_pack_2",
"type": "bundle",
"vc_prices": []
}A Xsolla API permite implementar a lógica de loja no jogo, incluindo a recuperação do catálogo de itens, gerenciamento do carrinho, criação de pedidos e acompanhamento de seu status. Dependendo do cenário de integração, as chamadas de API são divididas em subseções Admin e Catalog, que usam diferentes esquemas de autenticação.
O exemplo a seguir mostra um fluxo básico para configurar e operar uma loja, desde a criação de itens até a compra.
Crie um catálogo de itens para sua loja, como itens virtuais, pacotes ou moeda virtual.
Exemplos de chamadas de API:
Configure ferramentas de aquisição de usuários e monetização, como descontos, bônus, recompensas diárias ou cadeias de ofertas.
Exemplos de chamadas de API:
Configure a exibição do item em sua aplicação.
Aviso
Não use chamadas de API da subseção Admin para construir um catálogo de usuários. Essas chamadas de API têm limites de taxa e não são destinadas para tráfego de usuários.
Não use chamadas de API da subseção Admin para construir um catálogo de usuários. Essas chamadas de API têm limites de taxa e não são destinadas para tráfego de usuários.
Exemplos de chamadas de API:
Nota
Por padrão, as chamadas de API do catálogo retornam itens que estão atualmente disponíveis na loja no momento da solicitação. Para recuperar itens que ainda não estão disponíveis ou que não estão mais disponíveis, inclua o parâmetro
Por padrão, as chamadas de API do catálogo retornam itens que estão atualmente disponíveis na loja no momento da solicitação. Para recuperar itens que ainda não estão disponíveis ou que não estão mais disponíveis, inclua o parâmetro
"show_inactive_time_limited_items": 1 na solicitação do catálogo.
Você pode vender itens usando os seguintes métodos:
- Compra rápida — vender um SKU várias vezes.
- Compra de carrinho — o usuário adiciona itens ao carrinho, remove itens e atualiza quantidades dentro de um único pedido.
Se um item for comprado usando moedas virtuais em vez de moedas reais, use a chamada de API Criar pedido com item especificado comprado por moeda virtual. A interface de pagamento não é necessária, pois a cobrança é processada quando a chamada de API é executada.
Para a compra de itens gratuitos, use a chamada de API Criar pedido com item gratuito especificado ou a chamada de API Criar pedido com carrinho gratuito. A interface de pagamento não é necessária — o pedido é imediatamente definido ao status done.
Use a chamada de API do lado do cliente para criar um pedido com um item especificado. A chamada retorna um token usado para abrir a interface de pagamento.
Nota
As informações de desconto estão disponíveis para o usuário apenas na interface de pagamento. Códigos promocionais não são suportados.
As informações de desconto estão disponíveis para o usuário apenas na interface de pagamento. Códigos promocionais não são suportados.
A configuração e compra do carrinho podem ser realizadas no lado do cliente ou no lado do servidor.
Configure e compre um carrinho no cliente
Implemente a lógica de adicionar e remover itens por conta própria. Antes de chamar a API para configurar um carrinho, você não terá informações sobre quais promoções serão aplicadas à compra. Isso significa que o custo total e os detalhes dos itens bônus adicionados não serão conhecidos.
Implemente a seguinte lógica de carrinho:
- Após o jogador ter preenchido um carrinho, use a chamada de API Preencher carrinho com itens. A chamada retorna as informações atuais sobre os itens selecionados (preços antes e depois dos descontos, itens bônus).
- Atualize o conteúdo do carrinho com base nas ações do usuário:
- Para adicionar um item ou alterar a quantidade de um item, use a chamada de API Atualizar item do carrinho por ID do carrinho.
- Para remover um item, use a chamada de API Excluir item do carrinho por ID do carrinho.
Nota
Para obter o status atual do carrinho, use a chamada de API Obter carrinho do usuário atual.
Para obter o status atual do carrinho, use a chamada de API Obter carrinho do usuário atual.
- Use a chamada de API Criar pedido com todos os itens do carrinho atual. A chamada retorna o ID do pedido e o token de pagamento. O pedido recém-criado é definido para o status
newpor padrão.
Configure e compre um carrinho no servidor
Esta opção de configuração pode levar mais tempo para configurar o carrinho, já que cada alteração no carrinho deve ser acompanhada por chamadas de API.
Implemente a seguinte lógica de carrinho:
- Após o jogador ter preenchido um carrinho, use a chamada de API Preencher carrinho com itens. A chamada retorna informações atuais sobre os itens selecionados (preços antes e depois dos descontos, itens bônus).
- Use a chamada de API Criar pedido com todos os itens do carrinho atual. A chamada retorna o ID do pedido e o token de pagamento. O pedido recém-criado é definido ao status
newpor padrão.
Use o token retornado para abrir a interface de pagamento em uma nova janela. Outras maneiras de abrir a interface de pagamento estão descritas na documentação.
| Ação | Endpoint |
|---|---|
| Abrir no ambiente de produção. | https://secure.xsolla.com/paystation4/?token={token} |
| Abrir no modo sandbox. | https://sandbox-secure.xsolla.com/paystation4/?token={token} |
Nota
Use o modo sandbox durante o desenvolvimento e teste. Compras de teste não fazem cobranças de contas reais. Você pode usar cartões de teste.
Use o modo sandbox durante o desenvolvimento e teste. Compras de teste não fazem cobranças de contas reais. Você pode usar cartões de teste.
Após o primeiro pagamento real, uma política de pagamento sandbox estrita entra em vigor. Um pagamento no modo sandbox está disponível apenas para usuários especificados em Conta de Distribuidor > Configurações da Empresa > Usuários.
Comprar moedas e itens virtuais por moedas reais é possível apenas após assinar um acordo de licença com a Xsolla. Para isso, na Conta de Distribuidor, acesse Contratos & Impostos > Contratos, preencha o formulário do acordo e aguarde a confirmação. Pode levar até 3 dias úteis para revisar o contrato.
Para habilitar ou desabilitar o modo sandbox, altere o valor do parâmetro sandbox na solicitação para compra rápida e compra no carrinho. O modo sandbox está desativado por padrão.
Possíveis status do pedido:
new— pedido criadopaid— pagamento recebidodone— item entreguecanceled— pedido canceladoexpired— pedido expirado
Acompanhe o status do pedido usando um dos seguintes métodos:
Chamadas de API que retornam grandes conjuntos de registros (por exemplo, ao criar um catálogo) retornam dados em páginas. A paginação é um mecanismo que limita o número de itens retornados em uma única resposta de API e permite que você recupere páginas subsequentes sequencialmente.
Use os seguintes parâmetros para controlar o número de itens retornados:
limit— número de itens por páginaoffset— índice do primeiro item na página (a numeração começa em 0)has_more— indica se outra página está disponíveltotal_items_count— número total de itens
Exemplo de solicitação:
GET /items?limit=20&offset=40Exemplo de resposta:
{
"items": [...],
"has_more": true,
"total_items_count": 135
}Recomenda-se enviar solicitações subsequentes até que a resposta retorne has_more = false.
Datas e valores de tempo são passados no formato ISO 8601.
Os seguintes são suportados:
- Deslocamento UTC
- Valor
nullquando não há restrição de tempo para exibir um item - Timestamp Unix (em segundos) usado em alguns campos
Formato: YYYY-MM-DDTHH:MM:SS±HH:MM
Exemplo: 2026-03-16T10:00:00+03:00
A Xsolla suporta a tradução de campos voltados para o usuário, como nome e descrição do item. Valores traduzidos são passados como um objeto onde o código de idioma é usado como chave. A lista completa de idiomas suportados está disponível na documentação.
Campos suportados
A localização pode ser especificada para os seguintes parâmetros:
namedescriptionlong_description
Formato de localidade
A chave de localidade pode ser especificada em um dos seguintes formatos:
- Código de idioma de duas letras:
en,ru - Código de idioma de cinco letras:
en-US,ru-RU,de-DE
Exemplos
Exemplo com um código de idioma de duas letras:
{
"name": {
"en": "Starter Pack",
"ru": "Стартовый набор"
}
}Exemplo com um código de idioma de cinco letras:
{
"description": {
"en-US": "Premium bundle",
"de-DE": "Premium-Paket"
}
}Se ocorrer um erro, a API retorna um status HTTP e um corpo de resposta JSON. A lista completa de erros relacionados à loja está disponível na documentação.
Exemplo de resposta:
{
"errorCode": 1102,
"errorMessage": "Validation error",
"statusCode": 422,
"transactionId": "c9e1a..."
}errorCode— código de erro.errorMessage— descrição curta do erro.statusCode— status da resposta HTTP.transactionId— ID da solicitação. Retornado apenas em alguns casos.errorMessageExtended— detalhes adicionais do erro, como parâmetros da solicitação. Retornado apenas em alguns casos.
Exemplo de resposta estendida:
{
"errorCode": 7001,
"errorMessage": "Chain not found",
"errorMessageExtended": {
"chain_id": "test_chain_id",
"project_id": "test_project_id",
"step_number": 2
},
"statusCode": 404
}Códigos de status HTTP comuns
400— solicitação inválida401— erro de autenticação403— permissões insuficientes404— recurso não encontrado422— erro de validação429— limite de taxa excedido
Recomendações
- Lide com o status HTTP e o corpo da resposta juntos.
- Use
errorCodepara processar erros relacionados à lógica da aplicação. - Use
transactionIdpara identificar solicitações mais rapidamente ao analisar erros.
Transferir a descrição da OpenAPI
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/catalog/
Visão geral
Você pode usar itens virtuais e moedas virtuais para construir uma loja no jogo e configurar como ela é exibida para os usuários. Os seguintes tipos de itens estão disponíveis:
- Itens virtuais — bens no jogo como armas, skins ou impulsionadores. Podem ser vendidos por dinheiro real ou moedas virtuais.
- Moeda virtual — moeda no jogo usada para comprar itens virtuais. Pode ser vendida por moedas reais ou moedas virtuais.
- Pacotes de moedas virtuais — uma quantidade fixa de moedas virtuais. Pode ser vendida por moedas reais ou moedas virtuais.
Grupos são usados para organizar itens no catálogo. Eles permitem agrupar logicamente os itens e gerenciar como eles são exibidos.
Use chamadas de API da subseção Admin para criar, atualizar e excluir itens.
Use chamadas de API da subseção Catálogo para recuperar listas de itens e exibi-los aos usuários.
Aviso
Não use chamadas de API da subseção Admin para construir um catálogo de loja.
Não use chamadas de API da subseção Admin para construir um catálogo de loja.
Nota
A chamada de API Obter lista de itens virtuais retorna dados detalhados dos itens, incluindo preços e atributos, e suporta paginação. Use-a para exibir páginas de catálogo na vitrine.
A chamada de API Obter lista de todos os itens virtuais retorna o SKU do item, nome, descrição, bem como ID e nome do grupo sem paginação. Use-a para busca ou indexação do lado do cliente.
A chamada de API Obter lista de itens virtuais retorna dados detalhados dos itens, incluindo preços e atributos, e suporta paginação. Use-a para exibir páginas de catálogo na vitrine.
A chamada de API Obter lista de todos os itens virtuais retorna o SKU do item, nome, descrição, bem como ID e nome do grupo sem paginação. Use-a para busca ou indexação do lado do cliente.
Para compras com moedas virtuais, use a chamada de API Criar pedido com item especificado comprado por moeda virtual. A interface de pagamento não é necessária — a cobrança é processada quando a chamada de API é executada.
Exemplo de fluxo de compra com moeda virtual:
Visão geral
Game keys are single-use unique alphanumeric codes that grant users access to a game or DLC on gaming platforms. You can sell game keys via a direct link, through the store UI, or via a widget. You can also configure regional restrictions to sell game keys in specific countries. For detailed information, refer to the Game keys packages section.
User authentication is not required to sell game keys — the keys are sent to the email the user specified at checkout. You can configure authentication to enable additional scenarios: personalization, purchase limits, or an entitlement system. For detailed information, refer to the How to set up authentication when selling game keys section.
Game key sales flow:
- Create a game using the Create game API call.
- Configure regional restrictions.
- Upload keys to a game key package using the Upload codes API call to make them available for purchase.
- Display the game catalog with prices for the user's region using the Get games list API call.
- Create an order. For a fast purchase, you can use the Create order with all items from current cart API call, passing the game key SKU. The response returns a token for opening the payment UI.
- Implement the opening of the payment UI to pay for the order.
To receive timely notifications about successful payments and deliver items to the user, set up order status tracking, for example, using webhooks. The keys are sent to the email the user specified at checkout, and the order moves to the done status.
Visão geral
Bundles are sets of items sold as a single unit. A bundle can include virtual items, virtual currency, virtual currency packages, game keys, and other bundles. Use bundles to create starter packs, seasonal offers, and special deals.
Use the following API call groups to work with bundles:
- Use API calls from the Admin subsection to create, update, delete bundles, and manage their visibility.
- Use API calls from the Catalog subsection to retrieve bundles.
Purchase limits are configured via the limits object when creating or updating a bundle. For more information, refer to the Limits overview. You can also configure regional restrictions to sell items in specific countries.
Bundle management scenario:
- Create a bundle using the Create bundle API call. To verify the created bundle, use the Get bundle API call. To retrieve all bundles in the project, use the Get list of bundles API call.
- If needed, use the Update bundle API call to modify the bundle content or settings.
- Implement bundle display logic in your storefront using the Get list of bundles, Get specified bundle, or Get list of bundles by specified group API call.
- Create an order using the Cart and payment section. For example, for a fast purchase you can use the Create order with specified item API call, passing the bundle SKU. The response contains a token for opening the payment UI.
- Implement opening the payment UI to pay for the order.
- Set up order status tracking, for example using webhooks, to promptly receive data on successfully paid items and grant them to the user.
Pedido
Obtém um conjunto especificado.
Nota
Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho
Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.
Para mais informações sobre o JWT do usuário, consulte o bloco Segurança
para esta chamada.
Segurança
XsollaLoginUserJWT
Caminho
ID de projeto. Você pode encontrar esse parâmetro na sua Conta de Distribuidor, próximo ao nome do projeto e na barra de endereços do navegador ao trabalhar com um projeto. O URL tem o seguinte formato: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
Exemplo: 44056
Consulta
Código exclusivo que diferencia maiúsculas de minúsculas. Contém letras e números.
Exemplo: promo_code=WINTER2021
Exibe itens de tempo limitado que não estão disponíveis para o usuário. O prazo de validade desses itens não começou ou já expirou.
Padrão 0
Exemplo: show_inactive_time_limited_items=1
- https://store.xsolla.com/api/v2/project/{project_id}/items/bundle/sku/{sku}
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/{project_id}/items/bundle/sku/{sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/items/bundle/sku/kg_1?promo_code=WINTER2021&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'O conjunto especificado foi recebido com sucesso.
ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.
Grupo aos quais o item pertence.
Um identificador exclusivo para o grupo, normalmente usado para referenciá-lo em solicitações de API ou sistemas externos.
Exemplo: "exclusive"
Objeto com traduções para a descrição longa do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as variantes para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.
Any of:
Códigos de idioma minúsculos de duas letras.
Lista de atributos e seus valores correspondentes ao item. Pode ser usado para a filtragem de catálogos.
ID de atributo exclusivo. O external_id só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados.
Tipo de pacote. Use standard para criar um pacote com itens e especificar os SKUs dos itens incluídos no pacote. Use partner_side_content para criar um pacote vazio e adicionar itens do seu lado usando um webhook. Esse tipo é usado somente para a personalização de catálogos no lado do parceiro.
Enum"standard""partner_side_content"
URL da imagem. Para que a imagem seja exibida corretamente e carregue rapidamente na interface de pagamento, confira as nossas diretrizes de imagens e URLs:
- Formatos suportados: WebP (recomendado), PNG, JPG.
- Tamanho do arquivo: ≤ 50 KB (para WebP) ou ≤ 150 KB (para PNG e JPG).
- Tamanho da imagem: 280 x 280 px.
- Espaço de cores: sRGB.
- Protocolo: HTTPS com cache de longa duração para URLs versionados.
Preço do item.
Moeda do preço do item. Código de três letras de acordo com a ISO 4217.
Soma dos preços do conteúdo do conjunto.
Soma dos preços do conteúdo do conjunto com um desconto.
Exemplo: "100.99"
Soma dos preços do conteúdo do conjunto.
Exemplo: "100.99"
Moeda do preço do item. Código de três letras de acordo com a ISO 4217.
Preços virtuais.
Conteúdo do pacote de conjuntos.
ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados.
Exemplo: "com.xsolla.big_rocket_1"
Tipo de item: virtual_good/virtual_currency/bundle.
Exemplo: "virtual_currency"
URL da imagem.
Exemplo: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
Tipo de item virtual.
Possíveis valores:
consumable— Um item que desaparece do inventário após o uso (ex.: munição)..non_consumable— Um item que permanece no inventário por um tempo ilimitado.non_renewing_subscription— Item de tempo limitado que pode representar acesso a serviços ou conteúdos por um período específico.
Enum"consumable""non_consumable""non_renewing_subscription"
Exemplo: "non-consumable"
Lista de atributos e seus valores correspondentes ao item. Pode ser usado para a filtragem de catálogos.
ID de atributo exclusivo. O external_id só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados.
ID de valor exclusivo para um atributo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.
Preços dos itens.
Moeda do preço do item. 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"
Preços virtuais.
Preço do item em moedas virtuais com desconto.
Exemplo: 100
Limites de itens.
Limites de item para um usuário.
Quantidade máxima de itens que o usuário atual pode comprar.
Exemplo: 5
Quantidade restante de itens que o usuário atual pode comprar.
Exemplo: 3
One of:
O item limita o período de atualização recorrente para um usuário.
object or null
Determina a visibilidade do item no catálogo após o limite de compra ser atingido, até o próximo limite ser redefinido.
Aplica-se a itens para os quais redefinições recorrentes de limite estão configurados na matriz recurrent_schedule.
Se os limites redefinidos não forem configurados, o item não aparecerá no catálogo após o limite de compra ser atingido, independentemente do valor limit_exceeded_visibility.
Possíveis valores:
show— O item é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido. Nas chamadas API de recuperação de catálogo, quando o limite for atingido, o item será retornado com a marcaçãocan_be_bought: false. A próxima data de redefinição é retornada emreset_next_date.hide— O item não é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido, até o limite ser redefinido.
Enum"show""hide"
Limites de item para um item.
Grupo aos quais o item pertence.
Promoções aplicadas a itens específicos no carrinho. A matriz é retornada nos seguintes casos:
Uma promoção de desconto é configurada para um item específico.
Um código promocional com a configuração Desconto em itens selecionados é aplicado.
Se nenhuma promoção no nível do item for aplicada, é retornada uma matriz vazia.
Tipo de item bônus.
Enum"virtual_good""virtual_currency""bundle""physical_good""game_key""nft"
Nome do item bônus. Indisponível para o tipo de item bônus physical_good.
URL da imagem do item bônus. Indisponível para o tipo de item bônus physical_good.
Limites de itens.
Limites de item para um usuário.
Quantidade máxima de itens que o usuário atual pode comprar.
Exemplo: 5
Quantidade restante de itens que o usuário atual pode comprar.
Exemplo: 3
One of:
O item limita o período de atualização recorrente para um usuário.
object or null
Determina a visibilidade do item no catálogo após o limite de compra ser atingido, até o próximo limite ser redefinido.
Aplica-se a itens para os quais redefinições recorrentes de limite estão configurados na matriz recurrent_schedule.
Se os limites redefinidos não forem configurados, o item não aparecerá no catálogo após o limite de compra ser atingido, independentemente do valor limit_exceeded_visibility.
Possíveis valores:
show— O item é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido. Nas chamadas API de recuperação de catálogo, quando o limite for atingido, o item será retornado com a marcaçãocan_be_bought: false. A próxima data de redefinição é retornada emreset_next_date.hide— O item não é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido, até o limite ser redefinido.
Enum"show""hide"
Período de venda de itens.
Recompensa do item de ponto de valor.
Resposta
application/json
{ "item_id": 610316, "sku": "com.xsolla.kg_1", "name": "kg_10.00_bundle", "type": "bundle", "description": "pricePoint_44056_1.", "image_url": null, "long_description": null, "attributes": [], "is_free": false, "order": 999, "groups": [], "price": { "amount": "9.99", "currency": "USD", "amount_without_discount": "9.99" }, "total_content_price": { "amount": "10.99", "currency": "USD", "amount_without_discount": "10.99" }, "media_list": [], "virtual_prices": [], "promotions": [], "limits": { "per_user": { … } }, "can_be_bought": true, "bundle_type": "standard", "periods": [ { … } ], "custom_attributes": { "purchased": 0, "attr": "value" }, "content": [ { … } ], "vp_rewards": [ { … }, { … } ] }
Pedido
Recebe uma lista de conjuntos dentro de um grupo para montar um catálogo.
Atenção
Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
Todos os projetos têm uma limitação no número de itens que você pode obter na resposta. O valor padrão e máximo é 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
Nota
Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho
Esta chamada de API retorna dados genéricos do catálogo de itens quando usada sem autorização. Use a autorização para recuperar dados personalizados do usuário, como limites e promoções associadas ao item. Para fazer isso, passe o JWT do usuário no cabeçalho
Authorization.
Para mais informações sobre o JWT do usuário, consulte o bloco Segurança
para esta chamada.
Segurança
XsollaLoginUserJWT
Caminho
ID de projeto. Você pode encontrar esse parâmetro na sua Conta de Distribuidor, próximo ao nome do projeto e na barra de endereços do navegador ao trabalhar com um projeto. O URL tem o seguinte formato: https://publisher.xsolla.com/<merchant_id>/projects/<project_id>.
Exemplo: 44056
Consulta
Número do elemento a partir do qual a lista é gerada (a quantidade começa a partir de 0).
Exemplo: offset=0
Idioma de resposta. Código de idioma de duas letras minúsculas, de acordo com o padrão ISO 639-1 (por exemplo, en). Códigos de localização de cinco caracteres (por exemplo, en-US) são suportados nos campos de tradução, tais como name e description, mas são normalizados a códigos de duas letras nas respostas. Você pode encontrar a lista completa de idiomas suportados na documentação.
Padrão "en"
A lista de campos adicionais. Esses campos estarão na resposta se você enviá-los em sua solicitação.
Itens Enum"media_list""order""long_description""custom_attributes""item_order_in_group"
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 e o processo de determinação do país.
Exemplo: country=US
Código exclusivo que diferencia maiúsculas de minúsculas. Contém letras e números.
Exemplo: promo_code=WINTER2021
- https://store.xsolla.com/api/v2/project/{project_id}/items/bundle/group/{external_id}
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/{project_id}/items/bundle/group/{external_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/items/bundle/group/weapons?limit=50&offset=0&locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'A lista de conjuntos foi recebida com sucesso.
ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.
Grupo aos quais o item pertence.
Um identificador exclusivo para o grupo, normalmente usado para referenciá-lo em solicitações de API ou sistemas externos.
Exemplo: "exclusive"
Objeto com traduções para a descrição longa do item. Aceita valores em um dos dois formatos: códigos de idioma minúsculos de duas letras (por exemplo, en) ou códigos de localidade de cinco caracteres (por exemplo, en-US). Embora ambos os formatos sejam aceitos, as respostas retornam códigos de idioma minúsculos de duas letras. Quando ambas as variantes para o mesmo idioma são fornecidas (por exemplo, en e en-US), o último valor fornecido é armazenado. Você pode encontrar a lista completa de idiomas suportados na documentação.
Any of:
Códigos de idioma minúsculos de duas letras.
Lista de atributos e seus valores correspondentes ao item. Pode ser usado para a filtragem de catálogos.
ID de atributo exclusivo. O external_id só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados.
ID de valor exclusivo para um atributo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.
Tipo de pacote. Use standard para criar um pacote com itens e especificar os SKUs dos itens incluídos no pacote. Use partner_side_content para criar um pacote vazio e adicionar itens do seu lado usando um webhook. Esse tipo é usado somente para a personalização de catálogos no lado do parceiro.
Enum"standard""partner_side_content"
URL da imagem. Para que a imagem seja exibida corretamente e carregue rapidamente na interface de pagamento, confira as nossas diretrizes de imagens e URLs:
- Formatos suportados: WebP (recomendado), PNG, JPG.
- Tamanho do arquivo: ≤ 50 KB (para WebP) ou ≤ 150 KB (para PNG e JPG).
- Tamanho da imagem: 280 x 280 px.
- Espaço de cores: sRGB.
- Protocolo: HTTPS com cache de longa duração para URLs versionados.
Preço do item.
Moeda do preço do item. Código de três letras de acordo com a ISO 4217.
Soma dos preços do conteúdo do conjunto.
Soma dos preços do conteúdo do conjunto com um desconto.
Exemplo: "100.99"
Soma dos preços do conteúdo do conjunto.
Exemplo: "100.99"
Moeda do preço do item. Código de três letras de acordo com a ISO 4217.
Preços virtuais.
Preço do item em moeda virtual.
Exemplo: 200
Imagem da moeda virtual.
Exemplo: "http://image.png"
Conteúdo do pacote de conjuntos.
ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados.
Exemplo: "com.xsolla.big_rocket_1"
Tipo de item: virtual_good/virtual_currency/bundle.
Exemplo: "virtual_currency"
URL da imagem.
Exemplo: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
Tipo de item virtual.
Possíveis valores:
consumable— Um item que desaparece do inventário após o uso (ex.: munição)..non_consumable— Um item que permanece no inventário por um tempo ilimitado.non_renewing_subscription— Item de tempo limitado que pode representar acesso a serviços ou conteúdos por um período específico.
Enum"consumable""non_consumable""non_renewing_subscription"
Exemplo: "non-consumable"
Lista de atributos e seus valores correspondentes ao item. Pode ser usado para a filtragem de catálogos.
ID de atributo exclusivo. O external_id só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, traços e sublinhados.
ID de valor exclusivo para um atributo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.
Preços dos itens.
Moeda do preço do item. 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"
Preços virtuais.
Preço do item em moedas virtuais com desconto.
Exemplo: 100
Se o preço é padrão para um item.
Exemplo: true
Imagem da moeda virtual.
Exemplo: "http://image.png"
Nome da moeda virtual.
Exemplo: "SHOTGUN FOR TRUE RAIDERS"
Limites de itens.
Limites de item para um usuário.
Quantidade máxima de itens que o usuário atual pode comprar.
Exemplo: 5
Quantidade restante de itens que o usuário atual pode comprar.
Exemplo: 3
One of:
O item limita o período de atualização recorrente para um usuário.
object or null
Determina a visibilidade do item no catálogo após o limite de compra ser atingido, até o próximo limite ser redefinido.
Aplica-se a itens para os quais redefinições recorrentes de limite estão configurados na matriz recurrent_schedule.
Se os limites redefinidos não forem configurados, o item não aparecerá no catálogo após o limite de compra ser atingido, independentemente do valor limit_exceeded_visibility.
Possíveis valores:
show— O item é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido. Nas chamadas API de recuperação de catálogo, quando o limite for atingido, o item será retornado com a marcaçãocan_be_bought: false. A próxima data de redefinição é retornada emreset_next_date.hide— O item não é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido, até o limite ser redefinido.
Enum"show""hide"
Limites de item para um item.
Grupo aos quais o item pertence.
Nome do item. Deve conter pares chave/valor onde chave é uma localização com o formato "^[a-z]{2}", e o valor é uma cadeia de caracteres.
Padrão {"en":"Horror"}
Exemplo: {"en":"Horror","de":"Horror"}
Promoções aplicadas a itens específicos no carrinho. A matriz é retornada nos seguintes casos:
Uma promoção de desconto é configurada para um item específico.
Um código promocional com a configuração Desconto em itens selecionados é aplicado.
Se nenhuma promoção no nível do item for aplicada, é retornada uma matriz vazia.
Tipo de item bônus.
Enum"virtual_good""virtual_currency""bundle""physical_good""game_key""nft"
Nome do item bônus. Indisponível para o tipo de item bônus physical_good.
URL da imagem do item bônus. Indisponível para o tipo de item bônus physical_good.
Limites de itens.
Limites de item para um usuário.
Quantidade máxima de itens que o usuário atual pode comprar.
Exemplo: 5
Quantidade restante de itens que o usuário atual pode comprar.
Exemplo: 3
One of:
O item limita o período de atualização recorrente para um usuário.
object or null
Determina a visibilidade do item no catálogo após o limite de compra ser atingido, até o próximo limite ser redefinido.
Aplica-se a itens para os quais redefinições recorrentes de limite estão configurados na matriz recurrent_schedule.
Se os limites redefinidos não forem configurados, o item não aparecerá no catálogo após o limite de compra ser atingido, independentemente do valor limit_exceeded_visibility.
Possíveis valores:
show— O item é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido. Nas chamadas API de recuperação de catálogo, quando o limite for atingido, o item será retornado com a marcaçãocan_be_bought: false. A próxima data de redefinição é retornada emreset_next_date.hide— O item não é retornado nas chamadas API de recuperação de catálogo após o limite de compra ser atingido, até o limite ser redefinido.
Enum"show""hide"
Limites de item para um item.
Período de venda de itens.
Data em que o item especificado estará disponível para venda.
Exemplo: "2020-08-11T10:00:00+03:00"
Recompensa do item de ponto de valor.
Ativos adicionais do conjunto.
Resposta
application/json
{ "has_more": true, "items": [ { … } ] }
Visão geral
The cart is a purchasing mechanism that enables combining multiple items into a single order. A user can buy items of any type in any quantity for real currency, as well as use promo codes.
The cart is stored on the Xsolla side. Saving the cart across sessions depends on whether the user is authorized:
For authorized users, the cart is linked to a specific user and is saved across sessions as long as requests are sent on behalf of the same user.
For unauthorized users, saving the cart depends on passing the
x-unauthorized-idheader. To save the cart of an unauthorized user across sessions, pass the samex-unauthorized-idin every request. This option is available only for game key sales.
You can identify the cart in two ways: automatically by user's JWT or by cart ID (cart_id).
Cart management is available both on the client side and on the server side.
On the server side, you can fill the cart with items, e.g., when restoring a user session. The following actions are available on the client side:
- retrieve the current user's cart or a cart by ID
- fill the cart
- update items in the cart
- delete items from the cart
To purchase items from the cart, the client and server calls for order creation are used.
The cart’s time to live (TTL) is 72 hours by default. If its content changes, e.g., when a new item is added, the TTL is extended.
After successful payment, the cart isn’t cleared automatically. To clear the cart, use the following client-side API calls:
Delete cart item by cart ID and Delete cart item from current cart — the cart is cleared when you delete the last item from it.
Cart usage scenario:
Implement a store UI where the user will select items.
When the user selects items in the store, add them to the cart, e.g., using the Fill cart with items call. In the items array, you need to pass the SKUs and the required quantity of items.
Implement the cart viewing UI. When the user navigates to the cart, display its contents using the Get current user's cart call. The response will return information about the final price of the items, including discounts and applied promotions.
Implement the opening of the payment UI to pay for the order. For example, you can use the Create order with all items from particular cart call. The response returns a token to open the payment UI.
Configure order status tracking, e.g., using webhooks, to promptly receive data about successfully paid items and grant them to the user.
Note
To implement selling items in-game and online, refer to the integration guide.
Ciclo de vida do pedido
Compreender o ciclo de vida do pedido ajuda a rastrear pedidos e a implementar a lógica pós-compra corretamente, ou seja, a entrega dos itens.
O pedido passa pelos seguintes status:
| Status | Descrição | Observações |
new | O pedido é criado. O sistema aguarda pela confirmação do pagamento. | As descrições dos status de transação podem ser encontrados na documentação Pay Station API. |
paid | O pedido é pago (a transação mudou para o status done), e o item pode ser concedido ao usuário. | O pedido permanece no status new até que o pagamento seja confirmado. |
done | O item é concedido ao usuário. | — |
canceled | O pagamento foi reembolsado. | O pedido muda para esse status quando o status da transação muda para refunded. |
expired | Criar um novo pedido para um item, código promocional ou promoção limitados move qualquer pedido não pago contendo o item para o status expired. Apenas o pedido mais recente pode ser pago. | Se um usuário tentar pagar por um pedido expirado, a interface de pagamento exibirá um erro 2002, e o pagamento falhará. |
Nota
Quando o pedido muda para o status expired enquanto o usuário conclui o pagamento, mas o pagamento é bem-sucedido, o pedido muda do status expired para paid. Isso só se aplica se o limite de compra para o item do pedido não será excedido pelo pagamento.
Itens gratuitos
Use calls from this section to grant free items to users.
Operações
Visão geral
Os limites de compra permitem restringir a quantidade de itens disponíveis para compra por um único usuário ou por todos os usuários. Você também pode configurar redefinições de limite agendadas.
Os limites são armazenados no lado da Xsolla e são configurados no nível de item individual na Conta de Distribuidor ou via o objeto limits nas seguintes chamadas de API:
As informações de limite são retornadas no objeto items.limits nas seguintes chamadas de API para recuperar o catálogo de itens:
- Obter lista de itens virtuais
- Obter lista de moedas virtuais
- Obter lista de pacotes de moedas virtuais
- Obter lista de conjuntos
- Obter lista de jogos
As chamadas de API na subseção Gestão do grupo Limites permitem que você recupere o estado atual dos limites e os atualize para um usuário específico — por exemplo, redefina o contador após a conclusão de uma missão ou ajuste manualmente a quantidade restante.
Nota
Para informações detalhadas sobre como configurar limites no catálogo, consulte a seção Limites de compra de itens.
Para informações detalhadas sobre como configurar limites no catálogo, consulte a seção Limites de compra de itens.