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

Conjuntos

Operações

Obter lista de conjuntos

Pedido

Obtém uma lista de conjuntos 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.
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/bundle?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respostas

A lista de conjuntos foi recebida com sucesso.

Corpoapplication/json
itemsArray of objects(Catalog_client_bundle)
items[].​attributesArray of objects(Catalog_client-attributes-common)

Lista de atributos e seus valores correspondentes ao item. Pode ser usado para filtrar catálogos.

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(Catalog_bundle_type)

Tipo de pacote. Neste caso, é sempre standart.

Exemplo: "standart"
items[].​contentArray of objects(Catalog_client_content)

Conteúdo do conjunto de pacotes.

Exemplo: [{"attributes":[],"description":"Big Rocket - short description.","groups":[],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"name":"Big Rocket","price":{"amount":10.99,"amount_without_discount":10.99,"currency":"USD"},"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[].​namestring

Nome do item.

Exemplo: "Big Rocket"
items[].​content[].​priceobject or null

Preços dos itens.

items[].​content[].​price.​amountstring

Preço do item com desconto.

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

Preço do item.

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

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

Exemplo: "USD"
items[].​content[].​quantityinteger

Quantidade de item 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[].​content[].​virtual_pricesArray of objects

Preços virtuais.

items[].​content[].​virtual_prices[].​amountinteger

Preço do item em moeda virtual com desconto.

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

Preço do item.

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

Descrição da moeda virtual.

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

Imagem da moeda virtual.

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

Se o preço é padrão para um item.

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

Nome da moeda virtual.

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

SKU do item de moeda virtual.

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

Tipo de moeda virtual.

Exemplo: "virtual_currency"
items[].​descriptionstring or null(Catalog_client_description)

Descrição do item.

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

Grupos aos quais o item pertence.

Padrão []
Exemplo: [{"external_id":"horror","name":{"en":"Horror"}}]
items[].​groups[].​external_idstring
Exemplo: "horror"
items[].​groups[].​nameobject
Exemplo: {"en":"Horror"}
items[].​image_urlstring or null(Catalog_image_url)

URL da imagem.

Exemplo: "https://image.example.com"
items[].​is_freestring(Catalog_is_free)

Sempre false.

Padrão "false"
Exemplo: "false"
items[].​namestring(Catalog_client_name)

Nome do item.

Exemplo: "Big Rocket"
items[].​priceobject or null(Catalog_price)

Preço do item.

items[].​price.​amountstring(Catalog_amount)^\d*\.?\d*$obrigatório

Preço do item com desconto.

Exemplo: "100.99"
items[].​price.​amount_without_discountstring(Catalog_amount_without_discount)^\d*\.?\d*$obrigatório

Preço do item.

Exemplo: "100.99"
items[].​price.​currencystring(Catalog_currency)obrigatório

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

Exemplo: "USD"
items[].​skustring(Catalog_sku)

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

Exemplo: "bundle_1"
items[].​total_content_priceobject or null(Catalog_total_content_price)

Soma dos preços do conteúdo do conjunto.

items[].​total_content_price.​amountstring

Soma dos preços do conteúdo do conjunto com um desconto.

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

Soma dos preços do conteúdo do conjunto.

Exemplo: "100.99"
items[].​total_content_price.​currencystring(Catalog_currency)

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

Exemplo: "USD"
items[].​typestring(Catalog_type)

Tipo de item.

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

Preços virtuais.

items[].​virtual_prices[].​amountinteger

Preço do item em moeda virtual com desconto.

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

Preço do item em moedas virtuais.

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

Descrição da moeda virtual.

Exemplo: "Most popular gold"
items[].​virtual_prices[].​image_urlstring or null

Imagem da moeda virtual.

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

Se o preço é padrão para um item.

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

Nome da moeda virtual.

Exemplo: "Gold"
items[].​virtual_prices[].​skustring

SKU do item de moeda virtual.

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

Tipo de moeda virtual.

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

Obter conjunto especificado

Pedido

Obtém um conjunto especificado.

Segurança
AuthForClient
Caminho
project_idintegerobrigatório

ID do Projeto.

Exemplo: 44056
skustringobrigatório

Pacote SKU.

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

Respostas

O conjunto especificado foi recebido com êxito.

Corpoapplication/json
attributesArray of objects(Catalog_client-attributes-common)

Lista de atributos e seus valores correspondentes ao item. Pode ser usado para filtrar catálogos.

Padrão []
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"
attributes[].​namestring

Nome do atributo.

Exemplo: "Genre"
attributes[].​valuesArray of objects
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"
attributes[].​values[].​valuestring

Valor do atributo.

Exemplo: "Strategy"
bundle_typestring(Catalog_bundle_type)

Tipo de pacote. Neste caso, é sempre standart.

Exemplo: "standart"
contentArray of objects(Catalog_client_content)

Conteúdo do conjunto de pacotes.

Exemplo: [{"attributes":[],"description":"Big Rocket - short description.","groups":[],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"name":"Big Rocket","price":{"amount":10.99,"amount_without_discount":10.99,"currency":"USD"},"quantity":100,"sku":"big_rocket","type":"virtual_currency"}]
content[].​descriptionstring

Descrição do item.

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

URL da imagem.

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

Nome do item.

Exemplo: "Big Rocket"
content[].​priceobject or null

Preços dos itens.

content[].​price.​amountstring

Preço do item com desconto.

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

Preço do item.

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

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

Exemplo: "USD"
content[].​quantityinteger

Quantidade de item em um pacote.

Exemplo: 250
content[].​skustring

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

Exemplo: "big_rocket"
content[].​typestring

Tipo de item: virtual_good/virtual_currency/bundle.

Exemplo: "virtual_currency"
content[].​virtual_pricesArray of objects

Preços virtuais.

content[].​virtual_prices[].​amountinteger

Preço do item em moeda virtual com desconto.

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

Preço do item.

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

Descrição da moeda virtual.

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

Imagem da moeda virtual.

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

Se o preço é padrão para um item.

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

Nome da moeda virtual.

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

SKU do item de moeda virtual.

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

Tipo de moeda virtual.

Exemplo: "virtual_currency"
descriptionstring or null(Catalog_client_description)

Descrição do item.

Exemplo: "Big Rocket - description."
groupsArray of objects(Catalog_groups_response)

Grupos aos quais o item pertence.

Padrão []
Exemplo: [{"external_id":"horror","name":{"en":"Horror"}}]
groups[].​external_idstring
Exemplo: "horror"
groups[].​nameobject
Exemplo: {"en":"Horror"}
image_urlstring or null(Catalog_image_url)

URL da imagem.

Exemplo: "https://image.example.com"
is_freestring(Catalog_is_free)

Sempre false.

Padrão "false"
Exemplo: "false"
namestring(Catalog_client_name)

Nome do item.

Exemplo: "Big Rocket"
priceobject or null(Catalog_price)

Preço do item.

price.​amountstring(Catalog_amount)^\d*\.?\d*$obrigatório

Preço do item com desconto.

Exemplo: "100.99"
price.​amount_without_discountstring(Catalog_amount_without_discount)^\d*\.?\d*$obrigatório

Preço do item.

Exemplo: "100.99"
price.​currencystring(Catalog_currency)obrigatório

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

Exemplo: "USD"
skustring(Catalog_sku)

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

Exemplo: "bundle_1"
total_content_priceobject or null(Catalog_total_content_price)

Soma dos preços do conteúdo do conjunto.

total_content_price.​amountstring

Soma dos preços do conteúdo do conjunto com um desconto.

Exemplo: "100.99"
total_content_price.​amount_without_discountstring

Soma dos preços do conteúdo do conjunto.

Exemplo: "100.99"
total_content_price.​currencystring(Catalog_currency)

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

Exemplo: "USD"
typestring(Catalog_type)

Tipo de item.

Exemplo: "bundle"
virtual_pricesArray of objects(Catalog_virtual_prices)

Preços virtuais.

virtual_prices[].​amountinteger

Preço do item em moeda virtual com desconto.

Exemplo: 100
virtual_prices[].​amount_without_discountinteger

Preço do item em moedas virtuais.

Exemplo: 200
virtual_prices[].​descriptionstring or null

Descrição da moeda virtual.

Exemplo: "Most popular gold"
virtual_prices[].​image_urlstring or null

Imagem da moeda virtual.

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

Se o preço é padrão para um item.

Exemplo: true
virtual_prices[].​namestring

Nome da moeda virtual.

Exemplo: "Gold"
virtual_prices[].​skustring

SKU do item de moeda virtual.

Exemplo: "gold"
virtual_prices[].​typestring

Tipo de moeda virtual.

Exemplo: "virtual_currency"
Resposta
application/json
{
  "attributes": [],
  "bundle_type": "standard",
  "content": [
    { … }
  ],
  "description": "pricePoint_44056_1.",
  "groups": [],
  "is_free": false,
  "media_list": [],
  "name": "kg_10.00_bundle",
  "order": 999,
  "price": {
    "amount": 9.99,
    "amount_without_discount": 9.99,
    "currency": "USD"
  },
  "sku": "kg_1",
  "total_content_amount": {
    "amount": 10.99,
    "amount_without_discount": 10.99,
    "currency": "USD"
  },
  "type": "bundle",
  "virtual_prices": []
}

Token de usuário

Operações

Notificações

Operações

Pedido

Operações