Saltar al contenido

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

Solicitud

Obtiene una lista de lotes para generar un catálogo.

Atención. Todos los proyectos tienen la limitación del número de artículos que se pueden obtener en la respuesta. El valor por defecto y máximo es 50 artículos por respuesta.
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/bundle?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

La lista de lotes se recibió correctamente.

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

Lista de atributos y sus valores correspondientes al artículo. Puede utilizarse para el filtrado de catálogos.

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

Tipo de lote. En este caso, siempre es standart.

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

Contenido del paquete del lote.

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

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[].​namestring

Nombre del artículo.

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

Precios de artículos.

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

Precio del artículo con descuento.

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

Precio del artículo.

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

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

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

Cantidad del artículo 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[].​content[].​virtual_pricesArray of objects

Precios virtuales.

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

Precio del artículo en moneda virtual con descuento.

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

Precio del artículo.

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

Descripción de la moneda virtual.

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

Imagen de la moneda virtual.

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

Si el precio está predeterminado para un artículo.

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

Nombre de la moneda virtual.

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

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

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

Tipo de moneda virtual.

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

Descripción del artículo.

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

Grupos a los que pertenece el artículo.

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

URL de la imagen.

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

Siempre es false.

Predeterminado "false"
Ejemplo: "false"
items[].​namestring(Catalog_client_name)

Nombre del artículo.

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

Precio del artículo.

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

Precio del artículo con descuento.

Ejemplo: "100.99"
items[].​price.​amount_without_discountstring(Catalog_amount_without_discount)^\d*\.?\d*$requerido

Precio del artículo.

Ejemplo: "100.99"
items[].​price.​currencystring(Catalog_currency)requerido

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

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

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: "bundle_1"
items[].​total_content_priceobject or null(Catalog_total_content_price)

Suma de los precios del contenido del lote.

items[].​total_content_price.​amountstring

Suma de los precios de los contenidos del lote con un descuento.

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

Suma de los precios del contenido del lote.

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

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

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

Tipo de artículo.

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

Precios virtuales.

items[].​virtual_prices[].​amountinteger

Precio del artículo en moneda virtual con descuento.

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

Precio del artículo en moneda virtual.

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

Descripción de la moneda virtual.

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

Imagen de la moneda virtual.

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

Si el precio está predeterminado para un artículo.

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

Nombre de la moneda virtual.

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

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

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

Tipo de moneda virtual.

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

Solicitud

Obtiene un lote especificado.

Seguridad
AuthForClient
Ruta
project_idintegerrequerido

ID del proyecto.

Ejemplo: 44056
skustringrequerido

Código de artículo (SKU) del lote.

Ejemplo: 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>'

Respuestas

El lote especificado se recibió correctamente.

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

Lista de atributos y sus valores correspondientes al artículo. Puede utilizarse para el filtrado de catálogos.

Predeterminado []
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"
attributes[].​namestring

Nombre del atributo.

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

Valor del atributo.

Ejemplo: "Strategy"
bundle_typestring(Catalog_bundle_type)

Tipo de lote. En este caso, siempre es standart.

Ejemplo: "standart"
contentArray of objects(Catalog_client_content)

Contenido del paquete del lote.

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

Descripción del artículo.

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

URL de la imagen.

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

Nombre del artículo.

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

Precios de artículos.

content[].​price.​amountstring

Precio del artículo con descuento.

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

Precio del artículo.

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

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

Ejemplo: "USD"
content[].​quantityinteger

Cantidad del artículo en un paquete.

Ejemplo: 250
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"
content[].​typestring

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

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

Precios virtuales.

content[].​virtual_prices[].​amountinteger

Precio del artículo en moneda virtual con descuento.

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

Precio del artículo.

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

Descripción de la moneda virtual.

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

Imagen de la moneda virtual.

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

Si el precio está predeterminado para un artículo.

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

Nombre de la moneda virtual.

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

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

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

Tipo de moneda virtual.

Ejemplo: "virtual_currency"
descriptionstring or null(Catalog_client_description)

Descripción del artículo.

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

Grupos a los que pertenece el artículo.

Predeterminado []
Ejemplo: [{"external_id":"horror","name":{"en":"Horror"}}]
groups[].​external_idstring
Ejemplo: "horror"
groups[].​nameobject
Ejemplo: {"en":"Horror"}
image_urlstring or null(Catalog_image_url)

URL de la imagen.

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

Siempre es false.

Predeterminado "false"
Ejemplo: "false"
namestring(Catalog_client_name)

Nombre del artículo.

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

Precio del artículo.

price.​amountstring(Catalog_amount)^\d*\.?\d*$requerido

Precio del artículo con descuento.

Ejemplo: "100.99"
price.​amount_without_discountstring(Catalog_amount_without_discount)^\d*\.?\d*$requerido

Precio del artículo.

Ejemplo: "100.99"
price.​currencystring(Catalog_currency)requerido

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

Ejemplo: "USD"
skustring(Catalog_sku)

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: "bundle_1"
total_content_priceobject or null(Catalog_total_content_price)

Suma de los precios del contenido del lote.

total_content_price.​amountstring

Suma de los precios de los contenidos del lote con un descuento.

Ejemplo: "100.99"
total_content_price.​amount_without_discountstring

Suma de los precios del contenido del lote.

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

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

Ejemplo: "USD"
typestring(Catalog_type)

Tipo de artículo.

Ejemplo: "bundle"
virtual_pricesArray of objects(Catalog_virtual_prices)

Precios virtuales.

virtual_prices[].​amountinteger

Precio del artículo en moneda virtual con descuento.

Ejemplo: 100
virtual_prices[].​amount_without_discountinteger

Precio del artículo en moneda virtual.

Ejemplo: 200
virtual_prices[].​descriptionstring or null

Descripción de la moneda virtual.

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

Imagen de la moneda virtual.

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

Si el precio está predeterminado para un artículo.

Ejemplo: true
virtual_prices[].​namestring

Nombre de la moneda virtual.

Ejemplo: "Gold"
virtual_prices[].​skustring

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

Ejemplo: "gold"
virtual_prices[].​typestring

Tipo de moneda virtual.

Ejemplo: "virtual_currency"
Respuesta
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": [] }
Operaciones
Operaciones
Operaciones