Saltar para o conteúdo

Visão Geral

Digital Distribution Hub é uma nova solução Xsolla que visa conectar pagamentos digitais e baseados em dinheiro através da tecnologia de pagamentos push e e-commerce.

Essa referência combina pontos de extremidade de API para dois produtos Xsolla: In-Game Store e Pay Station. Há dois URLs base:

  • https://store.xsolla.com/api para os grupos Common, Catalog, Cart e Order.
  • https://ps.xsolla.com para o grupo Notifications.

Os pontos de extremidade da API no grupo Catalog não exigem autorização.

Para trabalhar com operações nos grupos Cart e Order, você precisa gerar um token via Create user token.

Observação

Esta referência mostra o design de uma API futura e não uma interface totalmente funcional. Atualmente, você pode experimentar apenas os pontos de extremidade dos grupos Catalog e Notifications. Se você quiser compartilhar seus comentários, envie um e-mail para techdoc@xsolla.com.
Transferir a descrição da OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/pt/api/digital-distribution-hub/
https://store.xsolla.com/api/
Operações
Operações
Operações

Pedido

Obtém uma lista de moedas virtuais para criar um catálogo.

Atenção. Todos os projetos têm a limitação no 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
AuthForClient
Caminho
project_idintegerobrigatório

ID do Projeto.

Exemplo: 44056
Consulta
limitinteger

Limite para o número de elementos na página.

Exemplo: limit=50
offsetinteger

Número do elemento a partir do qual a lista é gerada (a contagem começa a partir de 0).

Exemplo: offset=0
localestring

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

Padrão "en"
additional_fields[]Array of strings

A lista de campos adicionais. Esses campos estarão na resposta se você enviá-los em sua solicitação. Campos disponíveis media_list, order, long_description.

countrystring

País para calcular preços regionais e restrições de catálogos. Código de país maiúsculo de duas letras de acordo com o padrão ISO 3166-1 alpha-2. Se você não especificar o país explicitamente, ele será calculado com base no endereço IP do usuário.

Padrão "US"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/pt/api/digital-distribution-hub/v2/project/44056/items/virtual_currency?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

A lista de moedas virtuais foi recebida com sucesso.

Corpoapplication/json
itemsArray of objects(Catalog_inline_response_200_6_items)
Exemplo: [{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]}],"description":"Big Rocket - short description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1}},"is_free":false,"name":"Big Rocket","price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"sku":"big_rocket","type":"virtual_currency","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"shotgun_raider","type":"virtual_currency"}]},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"1"}]},{"external_id":"rating","name":"Rating","values":[{"value":"3.9"}]},{"external_id":"genre","name":"Genre","values":[{"value":"Strategy"},{"value":"Tactical"},"Turn-based"]}],"description":"description","groups":[{"external_id":"hair","name":"Hair"}],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1}},"is_free":false,"name":"SHOTGUN FOR TRUE RAIDERS","price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"sku":"shotgun_raider","type":"virtual_currency","virtual_prices":[]},{"attributes":[],"description":"description","groups":[],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1}},"is_free":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"shotgun_raider_2","type":"virtual_currency","virtual_prices":[]}]
Resposta
application/json
{ "items": [ {}, {}, {} ] }

Obter lista de pacotes de moedas virtuais

Pedido

Obtém uma lista de pacotes de moedas virtuais para criar 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 é de 50 itens por resposta. Para obter mais dados página por página, use os campos limit e offset.
Segurança
AuthForClient
Caminho
project_idintegerobrigatório

ID do Projeto.

Exemplo: 44056
Consulta
limitinteger

Limite para o número de elementos na página.

Exemplo: limit=50
offsetinteger

Número do elemento a partir do qual a lista é gerada (a contagem começa a partir de 0).

Exemplo: offset=0
localestring

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

Padrão "en"
additional_fields[]Array of strings

A lista de campos adicionais. Esses campos estarão na resposta se você enviá-los em sua solicitação. Campos disponíveis media_list, order, long_description.

countrystring

País para calcular preços regionais e restrições de catálogos. Código de país maiúsculo de duas letras de acordo com o padrão ISO 3166-1 alpha-2. Se você não especificar o país explicitamente, ele será calculado com base no endereço IP do usuário.

Padrão "US"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/pt/api/digital-distribution-hub/v2/project/44056/items/virtual_currency/package?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

A lista de pacotes de moedas virtuais foi recebida com sucesso.

Corpoapplication/json
itemsArray of objects(Catalog_inline_response_200_7_items)
Exemplo: [{"attributes":[],"bundle_type":"virtual_currency_package","content":[{"description":"Big Rocket - short description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1}},"name":"Big Rocket","quantity":100,"sku":"big_rocket","type":"virtual_currency"}],"description":"VC Short Package Description","groups":[],"image_url":"http://vc_package_image.png","is_free":false,"name":"VC Name first package","price":{"amount":"2.0000","amount_without_discount":"2.0000","currency":"USD"},"sku":"vc_package_1","type":"bundle","virtual_prices":[]},{"attributes":[],"bundle_type":"virtual_currency_package","content":[{"description":"description","image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1}},"name":"SHOTGUN FOR TRUE RAIDERS","quantity":200,"sku":"shotgun_raider","type":"virtual_currency"}],"description":"VC Short Package Description","groups":[],"image_url":"http://vc_package_image.png","is_free":false,"name":"VC Name third package","price":{"amount":"4.0000","amount_without_discount":"4.0000","currency":"USD"},"sku":"vc_package_3","type":"bundle","virtual_prices":[]}]
Resposta
application/json
{ "items": [ {}, {} ] }

Pedido

Obtém uma lista de itens virtuais para criar um catálogo.

Atenção. Todos os projetos têm a 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
AuthForClient
Caminho
project_idintegerobrigatório

ID do Projeto.

Exemplo: 44056
Consulta
limitinteger

Limite para o número de elementos na página.

Exemplo: limit=50
offsetinteger

Número do elemento a partir do qual a lista é gerada (a contagem começa a partir de 0).

Exemplo: offset=0
localestring

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

Padrão "en"
additional_fields[]Array of strings

A lista de campos adicionais. Esses campos estarão na resposta se você enviá-los em sua solicitação. Campos disponíveis media_list, order, long_description.

countrystring

País para calcular preços regionais e restrições de catálogos. Código de país maiúsculo de duas letras de acordo com o padrão ISO 3166-1 alpha-2. Se você não especificar o país explicitamente, ele será calculado com base no endereço IP do usuário.

Padrão "US"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/pt/api/digital-distribution-hub/v2/project/44056/items/virtual_items?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

A lista de itens virtuais foi recebida com êxito.

Corpoapplication/json
itemsArray of objects(Catalog_inline_response_200_5_items)
Exemplo: [{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"size_e3364991f92e751689a68b96598a5a5a84010b85","value":"5"}]}],"description":"Big Rocket - description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"Big Rocket","price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"sku":"big_rocket","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"}]},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"size_e3364991f92e751689a68b96598a5a5a84010b85","value":"5"}]},{"external_id":"rating","name":"Rating","values":[{"external_id":"rating_e3364991f92e751689a68b96598a5a5a84010b85","value":"3.9"}]}],"description":"description","groups":[{"external_id":"hair","name":"Hair"}],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"SHOTGUN FOR TRUE RAIDERS","price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"sku":"shotgun_raider","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"},{"amount":200,"amount_without_discount":200,"description":"description","image_url":"http://image.png","is_default":false,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test_2","type":"virtual_currency"}]},{"attributes":[],"description":"description","groups":[],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"shotgun_raider_2","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[]}]
Resposta
application/json
{ "items": [ {}, {}, {} ] }
Operações
Operações
Operações
Operações