Objeto com propriedades DRM.
- Direito à concessão (admin)
Revogar direito (admin)
Obter lista de jogos de propriedade do usuário
Resgatar código de jogo por cliente
Direito à concessão (admi...
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
Corpoapplication/jsonobrigatórioID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
Exemplo: {"sku":"com.xsolla.key_1"}
Objeto com propriedades do jogo.
Exemplo: {"sku":"com.xsolla.game_1"}
Que tipo de direitos devem ser concedidos. Se o parâmetro for definido como sandbox, o direito será concedido ao usuário no modo seguro. Se o parâmetro for definido como default, o direito será concedido ao usuário no modo ao vivo.
Enum"default""sandbox"
Exemplo: "default"
- https://store.xsolla.com/api/v2/project/{project_id}/admin/entitlement/grant
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/{project_id}/admin/entitlement/grant
- 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/entitlement/grant \
-H 'Content-Type: application/json' \
-d '{
"code": "AAAA-BBBB-CCCC-DDDD",
"drm": {
"sku": "com.xsolla.key_1"
},
"game": {
"sku": "com.xsolla.game_1"
},
"mode": "default",
"user_country": "US",
"user_external_id": "user-external-id"
}'Caminho
Corpoapplication/jsonobrigatórioID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
Exemplo: 44056
Objeto com propriedades DRM.
Exemplo: {"sku":"com.xsolla.key_1"}
Objeto com propriedades do jogo.
Exemplo: {"sku":"com.xsolla.game_1"}
Que tipo de direitos devem ser revogados. Se o parâmetro for definido como sandbox, o direito será revogado do usuário no modo sandbox. Se o parâmetro for definido como default, o direito será revogado do usuário no modo ativo.
Enum"default""sandbox"
Exemplo: "default"
- https://store.xsolla.com/api/v2/project/{project_id}/admin/entitlement/revoke
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/{project_id}/admin/entitlement/revoke
- 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/entitlement/revoke \
-H 'Content-Type: application/json' \
-d '{
"drm": {
"sku": "com.xsolla.key_1"
},
"game": {
"sku": "com.xsolla.game_1"
},
"mode": "default",
"user_external_id": "user-external-id"
}'Pedido
Obtenha a lista de jogos de propriedade do usuário. A resposta conterá uma matriz de jogos de propriedade de um usuário específico.
Atenção
Todos os projetos têm uma limitação do número de itens que você pode obter na resposta. O valor padrão e máximo é de 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 do número de itens que você pode obter na resposta. O valor padrão e máximo é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
Segurança
XsollaLoginUserJWT
Caminho
ID do projeto. Você pode encontrar esse parâmetro em sua Conta de Distribuidor ao lado do nome do projeto.
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
Que tipo de direitos devem ser devolvidos. Se o parâmetro for definido como 1, apenas os direitos recebidos pelo usuário no modo sandbox serão retornados. Se o parâmetro não for passado ou estiver definido como 0, apenas os direitos recebidos pelo usuário no modo ativo serão retornados.
Padrão 0
- https://store.xsolla.com/api/v2/project/{project_id}/entitlement
- Mock serverhttps://xsolla.redocly.app/_mock/pt/api/catalog/v2/project/{project_id}/entitlement
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/entitlement?limit=50&offset=0&sandbox=0&additional_fields%5B%5D=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Resposta
application/json
{ "has_more": false, "items": [ { … } ], "total_items_count": 1 }