A lista de moedas virtuais foi recebida com sucesso.
- Criar moeda virtual
Obter lista de moedas virtuais
Obter lista de pacotes de moedas virtuais (admin)
Criar pacote de moedas virtuais
Excluir pacote de moedas virtuais
Obter pacote de moedas virtuais
Atualizar pacote de moedas virtuais
Excluir moeda virtual
Obter moeda virtual
Atualizar moeda virtual
Obter lista de itens virtuais
Criar item virtual
Obter lista de itens virtuais por ID de grupo especificado externo
Obter lista de itens virtuais por ID de grupo especificado
Excluir item virtual
Obter item virtual
Atualizar item virtual
Criar moeda virtual
Catalog API (2.0.0)
- 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.
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/
Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/virtual_currency
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/{project_id}/admin/items/virtual_currency
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v2/project/44056/admin/items/virtual_currency?limit=50&offset=0'Resposta
application/json
{ "items": [ { … }, { … } ] }
Caminho
Corpoapplication/jsonID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
Lista de atributos.
Atenção. Não é possível especificar mais de 20 atributos para o item. Qualquer tentativa de exceder o limite resulta em um erro.
Um objeto JSON que contém atributos e valores de item. Os atributos permitem que você adicione mais informações a itens como o nível necessário do jogador para usar o item. Os atributos enriquecem a lógica interna do seu jogo e são acessíveis através de métodos GET e webhooks dedicados.
description(two-letter (object or null)) or (five-letter (object or null))(description-localization-object)
Objeto com traduções para a descrição 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 opções 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.
One of:
Objeto com traduções para a descrição 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 opções 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.
Grupo aos quais o item pertence.
Padrão []
Exemplo: [{"external_id":"horror","name":{"en":"Horror"}}]
Se o item é uma recompensa paga randomizada, como uma loot box.
Padrão false
Exemplo: false
long_description(two-letter (object or null)) or (five-letter (object or null))(long-description-localization-object)
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:
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.
Recursos adicionais do item, como capturas de tela, vídeos de jogabilidade e assim por diante.
Exemplo: [{"type":"image","url":"https://cdn3.xsolla.com/img/misc/images/71ab1e12126f2103e1868076f0acb21a.jpg"}]
name(two-letter (object or null)) or (five-letter (object or null))(name-localization-object)obrigatório
Objeto com traduções para o nome 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 idioma 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 opções 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.
One of:
Objeto com traduções para o nome 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 idioma 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 opções 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.
Exemplo: [{"amount":10.5,"country_iso":"US","currency":"USD","is_default":true,"is_enabled":true}]
ID de item exclusivo. O SKU só pode conter caracteres alfanuméricos latinos minúsculos e maiúsculos, pontos, traços e sublinhados.
Exemplo: "booster_mega_1"
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/virtual_currency
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/{project_id}/admin/items/virtual_currency
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/items/virtual_currency \
-H 'Content-Type: application/json' \
-d '{
"attributes": [
{
"external_id": "material",
"name": {
"en-US": "Material"
},
"values": [
{
"external_id": "gold",
"value": {
"en-US": "Gold"
}
}
]
}
],
"custom_attributes": {
"attr": "value",
"purchased": 0
},
"description": {
"de-DE": "Die Hauptwährung deines Königreichs",
"en-US": "The main currency of your kingdom"
},
"groups": [
"gold"
],
"is_enabled": true,
"is_free": false,
"is_paid_randomized_reward": false,
"limits": {
"per_item": 10000,
"per_user": 5
},
"name": {
"de-DE": "Goldmünze",
"en-US": "Gold coin"
},
"order": 1,
"periods": [
{
"date_from": "2020-08-11T10:00:00+03:00",
"date_until": "2020-08-11T20:00:00+03:00"
}
],
"prices": [
{
"amount": 100,
"currency": "USD",
"is_default": true,
"is_enabled": true
}
],
"sku": "com.xsolla.coin_1"
}'Resposta
application/json
{ "sku": "com.xsolla.item_1" }
Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/admin/items/virtual_currency/package
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/{project_id}/admin/items/virtual_currency/package
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
'https://store.xsolla.com/api/v2/project/44056/admin/items/virtual_currency/package?limit=50&offset=0'Resposta
application/json
{ "items": [ { … }, { … }, { … }, { … }, { … }, { … } ] }