Saltar al contenido
/
Obtener la lista de clave...

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

Cesta

Operaciones

Claves del juego

Operaciones

Obtener lista de juegos por grupo especificado

Solicitud

Obtiene una lista de juegos del grupo especificado 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
external_idstringrequerido

ID externo del grupo.

Predeterminado "all"
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://xsolla.redocly.app/_mock/es/api/digital-distribution-hub/v2/project/44056/items/game/group/{external_id}?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

La lista de juegos se recibió correctamente.

Cuerpoapplication/json
itemsArray of objects(Catalog_inline_response_200_items)
Ejemplo: [{"attributes":{"$ref":"#/components/examples/client-attribute-game/Catalog_value"},"description":"Game description","groups":[{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla games"}],"image_url":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","name":"Game name","sku":"game_1","type":"unit","unit_items":[{"drm_name":"Steam","drm_sku":"steam","has_keys":true,"is_free":false,"is_pre_order":true,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"release_date":"2020-08-11T10:00:00+03:00","sku":"game_key_01","type":"game_key","virtual_prices":[]},{"drm_name":"Origin","drm_sku":"origin","has_keys":false,"is_free":false,"is_pre_order":false,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"sku":"game_key_02","type":"game_key","virtual_prices":[]}],"unit_type":"game"},{"attributes":[{"external_id":"OS","name":"OS","values":[{"external_id":"9d5c5efb7c0f00a00fe4e3583f1215b0050bc723","value":"Windows"}]}],"description":"Game description","groups":[{"external_id":"all","name":"All games"}],"image_url":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","name":"Game name","sku":"game_2","type":"unit","unit_items":[{"drm_name":"Steam","drm_sku":"steam","has_keys":false,"is_free":false,"is_pre_order":false,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"sku":"game_key_01","type":"game_key","virtual_prices":[]}],"unit_type":"game"}]
Respuesta
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Obtener la lista de claves del juego por grupo especificado

Solicitud

Obtiene una lista de claves del juego del grupo especificado 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
external_idstringrequerido

ID externo del grupo.

Predeterminado "all"
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://xsolla.redocly.app/_mock/es/api/digital-distribution-hub/v2/project/44056/items/game/key/group/{external_id}?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

La lista de claves del juego se recibió correctamente.

Cuerpoapplication/json
itemsArray of objects(Catalog_inline_response_200_3_items)
Ejemplo: [{"attributes":{"$ref":"#/components/examples/client-attribute-game-horror/Catalog_value"},"description":"Game description","drm_name":"Steam","drm_sku":"steam","groups":[{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla games"}],"has_keys":true,"image_url":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","is_free":false,"is_pre_order":true,"name":"Game name","price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"release_date":"2020-08-11T10:00:00+03:00","sku":"game_1","type":"game_key","virtual_prices":[]},{"attributes":{"$ref":"#/components/examples/client-attribute-game-horror/Catalog_value"},"description":"Game description","drm_name":"Steam","drm_sku":"steam","groups":[{"external_id":"all","name":"All games"}],"has_keys":true,"image_url":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","is_free":false,"is_pre_order":false,"name":"Game name","price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"sku":"game_2","type":"game_key","virtual_prices":[]}]
Respuesta
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Obtener clave del juego para el catálogo

Solicitud

Obtiene una clave del juego para el catálogo.

Seguridad
AuthForClient
Ruta
project_idintegerrequerido

ID del proyecto.

Ejemplo: 44056
item_skustringrequerido

Código (SKU) del artículo.

Ejemplo: booster_mega_1
Consulta
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://xsolla.redocly.app/_mock/es/api/digital-distribution-hub/v2/project/44056/items/game/key/sku/booster_mega_1?locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

La clave del juego 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 []
descriptionstring

Descripción del artículo.

Ejemplo: "Game description"
drm_namestring

Nombre del DRM (gestión de derechos digitales).

Ejemplo: "Steam"
drm_skustring

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

Ejemplo: "steam"
groupsArray of objects(Catalog_inline_response_200_groups)

Grupos a los que pertenece el artículo.

Ejemplo: [{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla games"}]
has_keysboolean

Si es true, la clave del juego tiene claves para la venta.

Ejemplo: true
image_urlstring

URL de la imagen.

Ejemplo: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
is_freeboolean

Si es true, el artículo es gratuito.

Ejemplo: false
is_pre_orderboolean

Si es true, la clave del juego está reservada y la fecha de lanzamiento no ha pasado.

Ejemplo: true
namestring

Nombre del artículo.

Ejemplo: "Game name"
priceobject(Catalog_inline_response_200_price)

Precios de artículos.

release_datestring

Fecha de lanzamiento de la clave del juego en formato ISO 8601.

Ejemplo: "2020-08-11T10:00:00+03:00"
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: "game_1"
typestring

Tipo de artículo: game_key.

Ejemplo: "game_key"
virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

Precios virtuales.

Ejemplo: []
Respuesta
application/json
{
  "attributes": {
    "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
  },
  "description": "Game description",
  "drm_name": "Steam",
  "drm_sku": "steam",
  "groups": [
    { … },
    { … }
  ],
  "has_keys": true,
  "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
  "is_free": false,
  "is_pre_order": true,
  "name": "Game name",
  "price": {
    "amount": "30.5",
    "amount_without_discount": "30.5",
    "currency": "USD"
  },
  "release_date": "2020-08-11T10:00:00+03:00",
  "sku": "game_1",
  "type": "game_key",
  "virtual_prices": []
}

Árticulos y moneda virtuales

Operaciones

Lotes

Operaciones

Token del usuario

Operaciones

Notificaciones

Operaciones

Pedido

Operaciones