Saltar al contenido
/
Obtener lista de monedas...

Digital Distribution Hub (1.0.0)

Información general

Digital Distribution Hub es una nueva solución de Xsolla que tiene por objetivo conectar los pagos digitales y en efectivo a través de la tecnología de pagos únicos inmediatos ('push') y de comercio electrónico.

Esta referencia combina puntos finales de API para dos productos de Xsolla: In-Game Store y Pay Station. Hay dos URL base:

  • https://store.xsolla.com/api para los grupos Common, Catalog, Cart, y Order.
  • https://ps.xsolla.com para el grupo Notifications.

Los puntos finales de API en el grupo Catalog no requieren autorización.

Para realizar operaciones en los grupos Cart y Order, necesita generar un token a través de Create user token.

Nota

Esta referencia muestra un diseño de una futura API y no una interfaz plenamente funcional. Actualmente, solo puede probar los puntos finales de los grupos Catalog y Notifications. Si desea compartir sus comentarios, envíenos un correo electrónico a techdoc@xsolla.com.
Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/es/api/digital-distribution-hub/

Cesta

Operaciones

Claves del juego

Operaciones

Árticulos y moneda virtuales

Operaciones

Obtener lista de grupos de artículos

Solicitud

Obtiene una lista de grupos de artículos para crear un catálogo.

Seguridad
AuthForClient
Ruta
project_idintegerrequerido

ID del proyecto.

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

Respuestas

La lista de grupos se recibió correctamente.

Cuerpoapplication/json
groupsArray of objects(Catalog_inline_response_200_9_groups)
Ejemplo: [{"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 secundarios.

Ejemplo: [{"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 secundarios.

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

Grupos secundarios.

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

Descripción del grupo.

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

ID externo del grupo.

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

URL de la imagen.

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

Nivel de anidamiento del grupo.

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

Nombre del grupo.

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

Define el orden de disposición.

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

ID externo del grupo primario.

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

Descripción del grupo.

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

ID externo del grupo.

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

URL de la imagen del grupo.

groups[].​children[].​levelinteger

Nivel de anidamiento del grupo.

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

Nombre del grupo.

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

Define el orden de disposición.

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

ID externo del grupo primario.

Ejemplo: "hair"
groups[].​descriptionstring

Descripción del grupo.

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

ID externo del grupo.

Ejemplo: "hair"
groups[].​image_urlstring

URL de la imagen.

groups[].​levelinteger

Nivel de anidamiento del grupo.

Ejemplo: 0
groups[].​namestring

Nombre del grupo.

Ejemplo: "Hair"
groups[].​orderinteger

Define el orden de disposición.

Ejemplo: 1
groups[].​parent_external_idstring

ID externo del grupo primario.

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

Obtener lista de monedas virtuales

Solicitud

Obtiene una lista de monedas virtuales para crear un catálogo.

Atención. Todos los proyectos tienen la limitación del número de artículos que puede obtener en la respuesta. El valor por defecto y máximo es 50 artículos por cada respuesta. Para obtener más datos página por página, utilice los campos limit y offset.
Seguridad
AuthForClient
Ruta
project_idintegerrequerido

ID del proyecto.

Ejemplo: 44056
Consulta
limitinteger

Límite para el número de elementos presentes en la página.

Ejemplo: limit=50
offsetinteger

Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0).

Ejemplo: offset=0
localestring

Idioma de respuesta. Código de idioma de dos letras minúsculas según la norma ISO 639-1.

Predeterminado "en"
additional_fields[]Array of strings

Lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud. Campos disponibles media_list, order y long_description.

countrystring

País para calcular los precios regionales y las restricciones del catálogo. Código de país de dos letras en mayúscula según la norma ISO 3166-1 alpha-2. Si no especifica el país explícitamente, se calculará en función de la dirección IP del usuario.

Predeterminado "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>'

Respuestas

La lista de monedas virtuales se recibió correctamente.

Cuerpoapplication/json
itemsArray of objects(Catalog_inline_response_200_6_items)
Ejemplo: [{"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 y sus valores correspondientes al juego.

Atención: esta parte de la respuesta solo está disponible si envía el parámetro de consulta `additional_fields[]=attributes`.
Predeterminado []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

ID único del atributo. external_id solo puede contener caracteres alfanuméricos del alfabeto latino en minúsculas, guiones y guiones bajos.

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

Nombre del atributo.

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

ID de valor único para un atributo. external_id solo puede contener caracteres alfanuméricos del alfabeto latino en minúsculas, guiones y guiones bajos.

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

Valor del atributo.

Ejemplo: "Strategy"
items[].​descriptionstring

Descripción del artículo.

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

Grupos a los que pertenece el artículo.

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

URL de la imagen.

Ejemplo: "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 las opciones de artículo del inventario.

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

Define las propiedades consumibles si se trata de un artículo consumible, o null si se trata de un artículo no consumible.

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

Número total de usos restantes si se trata de un artículo consumible, o null si se trata de un artículo no consumible.

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

Define las propiedades de expiración si se trata de un artículo expirado, o null si se trata de un artículo no expirado.

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

Define el tipo de expiración del artículo.

Enumeración"minute""hour""day""week""month""year"
Ejemplo: "day"
items[].​inventory_options.​expiration_period.​valueinteger

Define el valor de un periodo de expiración.

Ejemplo: 1
items[].​is_freestring

Si es true, el artículo es gratuito.

Ejemplo: "false"
items[].​namestring

Nombre del artículo.

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

Precios de artículos.

items[].​price.​amountstring

Precio del artículo con descuento.

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

Precio del artículo.

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

Moneda de compra por defecto. Código de tres letras según la norma ISO 4217.

Ejemplo: "USD"
items[].​skustring

ID único del artículo. El código de un artículo (SKU) solo puede contener caracteres alfanuméricos latinos en minúsculas, puntos, guiones y guiones bajos.

Ejemplo: "big_rocket"
items[].​typestring

Tipo de artículo: virtual_good/virtual_currency/bundle.

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

Precios virtuales.

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

Precio del artículo con descuento en moneda virtual.

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

Precio del artículo.

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

Descripción de la moneda virtual.

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

Imagen de la moneda virtual.

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

Si el precio está predeterminado o no para el artículo.

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

Nombre de la moneda virtual.

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

Código de artículo (SKU) de la moneda virtual.

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

Tipo de moneda virtual.

Ejemplo: "virtual_currency"
Respuesta
application/json
{
  "items": [
    { … },
    { … },
    { … }
  ]
}

Obtener la lista de paquetes de moneda virtual

Solicitud

Obtiene una lista de paquetes de moneda virtual para crear un catálogo.

Atención. Todos los proyectos tienen la limitación del número de artículos que puede obtener en la respuesta. El valor por defecto y máximo es 50 artículos por cada respuesta. Para obtener más datos página por página, utilice los campos limit y offset.
Seguridad
AuthForClient
Ruta
project_idintegerrequerido

ID del proyecto.

Ejemplo: 44056
Consulta
limitinteger

Límite para el número de elementos presentes en la página.

Ejemplo: limit=50
offsetinteger

Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0).

Ejemplo: offset=0
localestring

Idioma de respuesta. Código de idioma de dos letras minúsculas según la norma ISO 639-1.

Predeterminado "en"
additional_fields[]Array of strings

Lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud. Campos disponibles media_list, order y long_description.

countrystring

País para calcular los precios regionales y las restricciones del catálogo. Código de país de dos letras en mayúscula según la norma ISO 3166-1 alpha-2. Si no especifica el país explícitamente, se calculará en función de la dirección IP del usuario.

Predeterminado "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>'

Respuestas

La lista de paquetes de moneda virtual se recibió correctamente.

Cuerpoapplication/json
itemsArray of objects(Catalog_inline_response_200_7_items)
Ejemplo: [{"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 y sus valores correspondientes al juego.

Atención: esta parte de la respuesta solo está disponible si envía el parámetro de consulta `additional_fields[]=attributes`.
Predeterminado []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

ID único del atributo. external_id solo puede contener caracteres alfanuméricos del alfabeto latino en minúsculas, guiones y guiones bajos.

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

Nombre del atributo.

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

ID de valor único para un atributo. external_id solo puede contener caracteres alfanuméricos del alfabeto latino en minúsculas, guiones y guiones bajos.

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

Valor del atributo.

Ejemplo: "Strategy"
items[].​bundle_typestring

Tipo de lote: standard/virtual_currency_package.

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

Contenido del paquete de moneda virtual.

Ejemplo: [{"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

Descripción del artículo.

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

URL de la imagen.

Ejemplo: "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 las opciones de artículo del inventario.

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

Define las propiedades consumibles si se trata de un artículo consumible, o null si se trata de un artículo no consumible.

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

Número total de usos restantes si se trata de un artículo consumible, o null si se trata de un artículo no consumible.

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

Define las propiedades de expiración si se trata de un artículo expirado, o null si se trata de un artículo no expirado.

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

Define el tipo de expiración de un artículo.

Enumeración"minute""hour""day""week""month""year"
Ejemplo: "day"
items[].​content[].​inventory_options.​expiration_period.​valueinteger

Define el valor del periodo de expiración.

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

Nombre del artículo.

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

Cantidad de moneda virtual que hay en un paquete.

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

ID único del artículo. El código de artículo (SKU) solo puede contener caracteres alfanuméricos del alfabeto latino en minúsculas, guiones y guiones bajos.

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

Tipo de artículo: virtual_good/virtual_currency/bundle.

Ejemplo: "virtual_currency"
items[].​descriptionstring

Descripción del artículo.

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

Grupos a los que pertenece el artículo.

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

URL de la imagen.

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

Si es true, el artículo es gratuito.

Ejemplo: "false"
items[].​namestring

Nombre del artículo.

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

Precios de artículos.

items[].​price.​amountstring

Precio del artículo con descuento.

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

Precio del artículo.

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

Moneda de compra por defecto. Código de tres letras según la norma ISO 4217.

Ejemplo: "USD"
items[].​skustring

ID único del artículo. El código de un artículo (SKU) solo puede contener caracteres alfanuméricos latinos en minúsculas, puntos, guiones y guiones bajos.

Ejemplo: "big_rocket"
items[].​typestring

Tipo de artículo: virtual_good/virtual_currency/bundle.

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

Precios virtuales.

items[].​virtual_prices[].​amountinteger

Precio del artículo con descuento en moneda virtual.

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

Precio del artículo.

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

Descripción de la moneda virtual.

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

Imagen de la moneda virtual.

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

Si el precio está predeterminado o no para el artículo.

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

Nombre de la moneda virtual.

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

Código de artículo (SKU) de la moneda virtual.

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

Tipo de moneda virtual.

Ejemplo: "virtual_currency"
Respuesta
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Lotes

Operaciones

Token del usuario

Operaciones

Notificaciones

Operaciones

Pedido

Operaciones