Saltar para o conteúdo

Digital Distribution Hub (1.0.0)

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
index.json
index.yaml
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/pt/api/digital-distribution-hub/

Carrinho

Operações

Chaves de jogo

Operações

Itens virtuais e moeda

Operações

Obter lista de grupos de itens

Pedido

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

Segurança
AuthForClient
Caminho
project_idintegerobrigatório

ID do Projeto.

Exemplo: 44056
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/items/groups \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

A lista de grupos foi recebida com sucesso.

Corpoapplication/json
groupsArray of objects(Catalog_inline_response_200_9_groups)
Exemplo: [{"children":[{"children":[{"children":[],"description":"Accessory","external_id":"accessory","level":2,"name":"Accessory","order":1,"parent_external_id":"background"}],"description":"Background description","external_id":"background","level":1,"name":"Background","order":1,"parent_external_id":"hair"}],"description":"Hair description","external_id":"hair","level":0,"name":"Hair","order":1},{"children":[],"description":"Super description","external_id":"group_external_id","level":0,"name":"Super","order":1}]
groups[].​childrenArray of objects(Catalog_inline_response_200_9_children_1)

Grupos filhos.

Exemplo: [{"children":[{"children":[],"description":"Accessory","external_id":"accessory","level":2,"name":"Accessory","order":1,"parent_external_id":"background"}],"description":"Background description","external_id":"background","level":1,"name":"Background","order":1,"parent_external_id":"hair"}]
groups[].​children[].​childrenArray of objects(Catalog_inline_response_200_9_children)

Grupos filhos.

Exemplo: [{"children":[],"description":"Accessory","external_id":"accessory","level":2,"name":"Accessory","order":1,"parent_external_id":"background"}]
groups[].​children[].​children[].​childrenArray of strings

Grupos filhos.

Exemplo: []
groups[].​children[].​children[].​descriptionstring

Descrição do grupo.

Exemplo: "Accessory"
groups[].​children[].​children[].​external_idstring

ID do grupo externo.

Exemplo: "accessory"
groups[].​children[].​children[].​image_urlstring

URL da imagem.

groups[].​children[].​children[].​levelinteger

Nível de aninhamento do grupo.

Exemplo: 2
groups[].​children[].​children[].​namestring

Nome do grupo.

Exemplo: "Accessory"
groups[].​children[].​children[].​orderinteger

Define a ordem do arranjo.

Exemplo: 1
groups[].​children[].​children[].​parent_external_idstring

ID do grupo externo pai.

Exemplo: "background"
groups[].​children[].​descriptionstring

Descrição do grupo.

Exemplo: "Background description"
groups[].​children[].​external_idstring

ID do grupo externo.

Exemplo: "background"
groups[].​children[].​image_urlstring

URL da imagem do grupo.

groups[].​children[].​levelinteger

Nível de aninhamento do grupo.

Exemplo: 1
groups[].​children[].​namestring

Nome do grupo.

Exemplo: "Background"
groups[].​children[].​orderinteger

Define a ordem do arranjo.

Exemplo: 1
groups[].​children[].​parent_external_idstring

ID do grupo externo pai.

Exemplo: "hair"
groups[].​descriptionstring

Descrição do grupo.

Exemplo: "Hair description"
groups[].​external_idstring

ID do grupo externo.

Exemplo: "hair"
groups[].​image_urlstring

URL da imagem.

groups[].​levelinteger

Nível de aninhamento do grupo.

Exemplo: 0
groups[].​namestring

Nome do grupo.

Exemplo: "Hair"
groups[].​orderinteger

Define a ordem do arranjo.

Exemplo: 1
groups[].​parent_external_idstring

ID do grupo externo pai.

Resposta
application/json
{
  "groups": [
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Obter lista de moedas virtuais

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://store.xsolla.com/api/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":[]}]
items[].​attributesArray of objects(Catalog_client-attributes)

Lista de atributos e seus valores correspondentes ao Jogo.

Atenção. Essa parte da resposta estará disponível somente se você enviar o parâmetro de consulta `additional_fields[]=attributes`.
Padrão []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

ID de atributo exclusivo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.

Exemplo: "attribute_1"
items[].​attributes[].​namestring

Nome do atributo.

Exemplo: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

ID de valor exclusivo para um atributo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.

Exemplo: "attribute_value"
items[].​attributes[].​values[].​valuestring

Valor do atributo.

Exemplo: "Strategy"
items[].​descriptionstring

Descrição do item.

Exemplo: "Big Rocket - description"
items[].​groupsArray of objects(Catalog_inline_response_200_groups)

Grupos aos quais o item pertence.

Exemplo: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
Exemplo: "accessory"
items[].​groups[].​namestring
Exemplo: "Accessory"
items[].​image_urlstring

URL da imagem.

Exemplo: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​inventory_optionsobject(Catalog_inline_response_200_5_inventory_options)

Define as opções de item de inventário.

items[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

Define as propriedades consumíveis se este for um item consumível ou null se este for um item não consumível.

items[].​inventory_options.​consumable.​usages_countinteger or null

Número total de utilizações restantes se este for um item consumível ou null se este for um item não consumível.

Exemplo: 1
items[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_5_inventory_options_expiration_period)

Define as propriedades de expiração se este for um item expirado ou null se este for um item não expirado.

items[].​inventory_options.​expiration_period.​typestring

Define o tipo de validade do item.

Enum"minute""hour""day""week""month""year"
Exemplo: "day"
items[].​inventory_options.​expiration_period.​valueinteger

Define o valor para um período de validade.

Exemplo: 1
items[].​is_freestring

Se true, o item é gratuito.

Exemplo: "false"
items[].​namestring

Nome do item.

Exemplo: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

Preços dos itens.

items[].​price.​amountstring

Preço do item com desconto.

Exemplo: "100.99"
items[].​price.​amount_without_discountstring

Preço do item.

Exemplo: "100.99"
items[].​price.​currencystring

Moeda de compra padrão. Código de três letras de acordo com o padrão ISO 4217.

Exemplo: "USD"
items[].​skustring

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

Exemplo: "big_rocket"
items[].​typestring

Tipo de item: virtual_good/virtual_currency/bundle.

Exemplo: "virtual_currency"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

Preços virtuais.

Exemplo: [{"amount":100,"amount_without_discount":100,"image_url":"http://image.png","is_default":true,"sku":"shotgun_raider"}]
items[].​virtual_prices[].​amountinteger

Preço do item com desconto em moedas virtuais.

Exemplo: 100
items[].​virtual_prices[].​amount_without_discountinteger

Preço do item.

Exemplo: 200
items[].​virtual_prices[].​descriptionstring

Descrição da moeda virtual.

Exemplo: "Big Rocket - description"
items[].​virtual_prices[].​image_urlstring

Imagem da moeda virtual.

Exemplo: "http://image.png"
items[].​virtual_prices[].​is_defaultboolean

Se o preço é padrão para o item ou não.

Exemplo: true
items[].​virtual_prices[].​namestring

Nome da moeda virtual.

Exemplo: "SHOTGUN FOR TRUE RAIDERS"
items[].​virtual_prices[].​skustring

SKU do item de moeda virtual.

Exemplo: "vc_test"
items[].​virtual_prices[].​typestring

Tipo de moeda virtual.

Exemplo: "virtual_currency"
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://store.xsolla.com/api/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":[]}]
items[].​attributesArray of objects(Catalog_client-attributes)

Lista de atributos e seus valores correspondentes ao Jogo.

Atenção. Essa parte da resposta estará disponível somente se você enviar o parâmetro de consulta `additional_fields[]=attributes`.
Padrão []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

ID de atributo exclusivo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.

Exemplo: "attribute_1"
items[].​attributes[].​namestring

Nome do atributo.

Exemplo: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

ID de valor exclusivo para um atributo. O external_id pode conter apenas caracteres alfanuméricos latinos minúsculos, traços e sublinhados.

Exemplo: "attribute_value"
items[].​attributes[].​values[].​valuestring

Valor do atributo.

Exemplo: "Strategy"
items[].​bundle_typestring

Tipo de conjunto: standard/virtual_currency_package.

Exemplo: "virtual_currency_package"
items[].​contentArray of objects(Catalog_inline_response_200_7_content)

Conteúdo do pacote de moedas virtuais.

Exemplo: [{"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"}]
items[].​content[].​descriptionstring

Descrição do item.

Exemplo: "Big Rocket - description"
items[].​content[].​image_urlstring

URL da imagem.

Exemplo: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​content[].​inventory_optionsobject(Catalog_inline_response_200_7_inventory_options)

Define as opções de item de inventário.

items[].​content[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

Define as propriedades consumíveis se este for um item consumível ou null se este for um item não consumível.

items[].​content[].​inventory_options.​consumable.​usages_countinteger or null

Número total de utilizações restantes se este for um item consumível ou null se este for um item não consumível.

Exemplo: 1
items[].​content[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_7_inventory_options_expiration_period)

Define as propriedades de expiração se este for um item expirado ou null se este for um item não expirado.

items[].​content[].​inventory_options.​expiration_period.​typestring

Define o tipo de validade de um item.

Enum"minute""hour""day""week""month""year"
Exemplo: "day"
items[].​content[].​inventory_options.​expiration_period.​valueinteger

Define o valor para o período de validade.

Exemplo: 1
items[].​content[].​namestring

Nome do item.

Exemplo: "Big Rocket"
items[].​content[].​quantityinteger

Quantia de moedas virtuais em um pacote.

Exemplo: 250
items[].​content[].​skustring

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

Exemplo: "big_rocket"
items[].​content[].​typestring

Tipo de item: virtual_good/virtual_currency/bundle.

Exemplo: "virtual_currency"
items[].​descriptionstring

Descrição do item.

Exemplo: "Big Rocket - description"
items[].​groupsArray of objects(Catalog_inline_response_200_groups)

Grupos aos quais o item pertence.

Exemplo: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
Exemplo: "accessory"
items[].​groups[].​namestring
Exemplo: "Accessory"
items[].​image_urlstring

URL da imagem.

Exemplo: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​is_freestring

Se true, o item é gratuito.

Exemplo: "false"
items[].​namestring

Nome do item.

Exemplo: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

Preços dos itens.

items[].​price.​amountstring

Preço do item com desconto.

Exemplo: "100.99"
items[].​price.​amount_without_discountstring

Preço do item.

Exemplo: "100.99"
items[].​price.​currencystring

Moeda de compra padrão. Código de três letras de acordo com o padrão ISO 4217.

Exemplo: "USD"
items[].​skustring

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

Exemplo: "big_rocket"
items[].​typestring

Tipo de item: virtual_good/virtual_currency/bundle.

Exemplo: "bundle"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

Preços virtuais.

items[].​virtual_prices[].​amountinteger

Preço do item com desconto em moedas virtuais.

Exemplo: 100
items[].​virtual_prices[].​amount_without_discountinteger

Preço do item.

Exemplo: 200
items[].​virtual_prices[].​descriptionstring

Descrição da moeda virtual.

Exemplo: "Big Rocket - description"
items[].​virtual_prices[].​image_urlstring

Imagem da moeda virtual.

Exemplo: "http://image.png"
items[].​virtual_prices[].​is_defaultboolean

Se o preço é padrão para o item ou não.

Exemplo: true
items[].​virtual_prices[].​namestring

Nome da moeda virtual.

Exemplo: "SHOTGUN FOR TRUE RAIDERS"
items[].​virtual_prices[].​skustring

SKU do item de moeda virtual.

Exemplo: "vc_test"
items[].​virtual_prices[].​typestring

Tipo de moeda virtual.

Exemplo: "virtual_currency"
Resposta
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Conjuntos

Operações

Token de usuário

Operações

Notificações

Operações

Pedido

Operações