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

Token de usuário

Operações

Notificações

Operações

Pedido

Operações

Obter pedido

Pedido

Recupera um pedido especificado.

Segurança
AuthForClient
Caminho
project_idintegerobrigatório

ID do Projeto.

Exemplo: 44056
order_idstringobrigatório

ID do Pedido.

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

Respostas

Solicitação de pedido bem-sucedida.

Corpoapplication/json
contentobject(Order_inline_response_200_1_content)

Detalhes do pedido.

content.​is_freestring

Se true, o pedido é gratuito.

Exemplo: "false"
content.​itemsArray of objects(Order_inline_response_200_1_content_items)

Lista de itens.

Exemplo: [{"is_free":false,"price":{"amount":"30","amount_without_discount":"30","currency":"USD"},"quantity":1,"sku":"some_sku"}]
content.​items[].​is_freestring

Se true, o item é gratuito.

Exemplo: "false"
content.​items[].​priceobject(Order_inline_response_200_1_content_price_1)

Preço do item.

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

Preço do item com desconto.

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

Preço do item.

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

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

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

Quantidade do item.

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

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

Exemplo: "some_sku"
content.​priceobject(Order_inline_response_200_1_content_price)

Preço do pedido.

content.​price.​amountstring

Preço do pedido com desconto.

Exemplo: "30"
content.​price.​amount_without_discountstring

Preço do pedido.

Exemplo: "30"
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.​virtual_priceobject(Order_inline_response_200_1_content_virtual_price)

Preço do pedido em moedas virtuais.

content.​virtual_price.​amountstring

Preço do pedido com desconto.

Exemplo: "100"
content.​virtual_price.​amount_without_discountstring

Preço do pedido.

Exemplo: "150"
content.​virtual_price.​currencystring

SKU da moeda virtual usada no pedido.

Exemplo: "test_vc"
order_idinteger

ID do Pedido.

Exemplo: 1
statusstring

Status do pedido: new/paid/done/canceled.

Exemplo: "paid"
Resposta
application/json
{
  "content": {
    "is_free": "false",
    "items": [ … ],
    "price": { … }
  },
  "order_id": 1,
  "status": "paid"
}

Criar pedido com todos os itens do carrinho atual

Pedido

Cria um pedido com todos os itens do carrinho. O pedido criado receberá um status de pedido new.

Segurança
AuthForClient
Caminho
project_idintegerobrigatório

ID do Projeto.

Exemplo: 44056
Corpoapplication/jsonobrigatório

Objeto com dados de criação de pedidos.

currencystring(Cart-Payment_settings_currency)obrigatório

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

geotypenumberobrigatório

ID do parceiro distribuidor do lado da Xsolla.

Exemplo: 13038
quantityinteger

Quantidade do item.

Exemplo: 1
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/distribution_hub/payment/cart \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "geotype": 13038
  }'

Respostas

O pedido foi criado com sucesso.

Corpoapplication/json
billing_infoobject(Order_inline_response_200_billing_info)

Informações de faturamento.

billing_info.​direct_taxArray of objects(Order_inline_response_200_billing_info_direct_tax)
billing_info.​direct_tax[].​amountnumber
Exemplo: 150
billing_info.​direct_tax[].​namestring
Exemplo: "TAX"
billing_info.​direct_tax[].​ratenumber
Exemplo: 10
billing_info.​indirect_taxArray of objects(Order_inline_response_200_billing_info_indirect_tax)
billing_info.​indirect_tax[].​amountnumber
Exemplo: 246.75
billing_info.​indirect_tax[].​namestring
Exemplo: "VAT"
billing_info.​indirect_tax[].​ratenumber
Exemplo: 20
billing_info.​priceobject(Order_inline_response_200_billing_info_price)
billing_info.​price.​amountnumber
Exemplo: 1480.45
billing_info.​price.​currencystring= 3 characters

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

Exemplo: "USD"
order_idinteger

ID do Pedido.

Resposta
application/json
{
  "billing_info": {
    "direct_taxes": [ … ],
    "indirect_taxes": [ … ],
    "price": { … }
  },
  "order_id": 641
}

Criar pedido com todos os itens de um carrinho específico

Pedido

Cria um pedido com todos os itens do carrinho específico. O pedido criado receberá um status de pedido new.

Segurança
AuthForClient
Caminho
project_idintegerobrigatório

ID do Projeto.

Exemplo: 44056
cart_idstringobrigatório

ID do Carrinho.

Exemplo: custom_id
Corpoapplication/jsonobrigatório

Objeto com dados de criação de pedidos.

currencystring(Cart-Payment_settings_currency)obrigatório

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

geotypenumberobrigatório

ID do parceiro distribuidor do lado da Xsolla.

Exemplo: 13038
quantityinteger

Quantidade do item.

Exemplo: 1
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/distribution_hub/payment/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "geotype": 13038
  }'

Respostas

O pedido foi criado com sucesso.

Corpoapplication/json
billing_infoobject(Order_inline_response_200_billing_info)

Informações de faturamento.

billing_info.​direct_taxArray of objects(Order_inline_response_200_billing_info_direct_tax)
billing_info.​direct_tax[].​amountnumber
Exemplo: 150
billing_info.​direct_tax[].​namestring
Exemplo: "TAX"
billing_info.​direct_tax[].​ratenumber
Exemplo: 10
billing_info.​indirect_taxArray of objects(Order_inline_response_200_billing_info_indirect_tax)
billing_info.​indirect_tax[].​amountnumber
Exemplo: 246.75
billing_info.​indirect_tax[].​namestring
Exemplo: "VAT"
billing_info.​indirect_tax[].​ratenumber
Exemplo: 20
billing_info.​priceobject(Order_inline_response_200_billing_info_price)
billing_info.​price.​amountnumber
Exemplo: 1480.45
billing_info.​price.​currencystring= 3 characters

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

Exemplo: "USD"
order_idinteger

ID do Pedido.

Resposta
application/json
{
  "billing_info": {
    "direct_taxes": [ … ],
    "indirect_taxes": [ … ],
    "price": { … }
  },
  "order_id": 641
}