Saltar al contenido
/
Obtener juego para el cat...

Shop Builder API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/shop-builder/
https://store.xsolla.com/api/

Admin

Operaciones

Catálogo personalizado

Esta API permite especificar reglas para los atributos de usuario. Si el usuario cumple todas las condiciones de una regla específica, se mostrarán los elementos personalizados.

Para promociones personalizadas, consulte la sección Promotions.

Para transmitir atributos antes de una compra, puede utilizar Xsolla Login API o transmitirlos a la propiedad user.attributes mientras se genera el token utilizando Pay Station API.

Operaciones

Admin

Operaciones

Catálogo

Operaciones

Cesta (cliente)

Operaciones

Cesta (lado del servidor)

Operaciones

Pago (lado del cliente)

Operaciones

Pago (lado del servidor)

Operaciones

Pedido

Operaciones

Artículos gratuitos

Operaciones

Webhooks

Operaciones

Pedidos anticipados

Operaciones

Comerciante

Operaciones

Catálogo

Esta API permite obtener cualquier tipo de artículo vendible o artículo específico.

Operaciones

Regiones comunes

Operaciones

Catálogo

Operaciones

Obtener clave del juego para el catálogoClient-side

Solicitud

Obtiene una clave de juego para el catálogo.

Nota

Este punto final, accesible sin autorización, devuelve datos genéricos. Sin embargo, la autorización enriquece la respuesta con detalles específicos del usuario para obtener un resultado personalizado, como los límites de usuario y las promociones disponibles.
Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
item_skustringrequerido

SKU del artículo.

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

La lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud.

Elementos Enumeración"media_list""order""long_description""custom_attributes""item_order_in_group"
countrystring

Código de país de dos letras mayúsculas de conformidad con la norma ISO 3166-1 alpha-2. Consulte la documentación para obtener información detallada sobre los países admitidos por Xsolla y el proceso de determinación del país.

Ejemplo: country=US
promo_codestring[ 1 .. 128 ] characters

Código único que distingue entre mayúsculas y minúsculas. Contiene letras y números.

Ejemplo: promo_code=WINTER2021
show_inactive_time_limited_itemsinteger

Muestra los artículos de duración limitada que no están disponibles para el usuario. El periodo de validez de dichos artículos no ha comenzado o ya ha expirado.

Predeterminado 0
Ejemplo: show_inactive_time_limited_items=1
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/items/game/key/sku/{item_sku}?locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

La clave del juego se recibió correctamente.

Cuerpoapplication/json
attributesArray of objects(Game-Keys_schemas-client-attributes)

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

Predeterminado []
Ejemplo: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
can_be_boughtboolean(Can_be_bought)

Si es true, el usuario puede comprar un artículo.

Ejemplo: true
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 de DRM. El SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

Ejemplo: "steam_key_1"
groupsArray of objects(items_client_groups_response)

Grupos a los que pertenece el artículo.

Predeterminado []
Ejemplo: [{"external_id":"exclusive","name":"Exclusive"}]
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(value-is_free)

Si es true, el artículo es gratuito.

Predeterminado false
Ejemplo: false
is_pre_orderboolean

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

Ejemplo: true
limitsobject or null(Catalog_item_limits)

Límites del artículo.

namestring

Nombre del artículo.

Ejemplo: "Game name"
periodsArray of objects or null(item-periods)

Periodo de venta del artículo.

priceobject

Precios de artículos.

Ejemplo: {"amount":"30.5","amount_without_discount":"30.5","currency":"USD"}
promotionsArray of objects(Catalog_item_promotions)

Promociones aplicadas para artículos específicos de la cesta. La matriz se devuelve en los siguientes casos:

  • Se configura un descuento promocional para un artículo específico.

  • Se aplica un código promocional con el parámetro Descuento en artículos seleccionados.

Si no se aplican promociones a nivel de artículo, se devuelve una matriz vacía.

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 SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

Ejemplo: "com.xsolla.game_1"
typestring

Tipo de artículo: game_key.

Ejemplo: "game_key"
virtual_pricesArray of objects

Precios virtuales.

Ejemplo: []
Respuesta
application/json
{
  "attributes": [
    { … },
    { … }
  ],
  "can_be_bought": true,
  "description": "Game description",
  "drm_name": "Steam",
  "drm_sku": "steam_key_1",
  "groups": [
    { … },
    { … }
  ],
  "has_keys": true,
  "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
  "is_free": false,
  "is_pre_order": true,
  "limits": null,
  "name": "Game name",
  "periods": [
    { … }
  ],
  "price": {
    "amount": "30.5",
    "amount_without_discount": "30.5",
    "currency": "USD"
  },
  "promotions": [],
  "release_date": "2020-08-11T10:00:00+03:00",
  "sku": "com.xsolla.game_1",
  "type": "game_key",
  "virtual_prices": []
}

Obtener juego para el catálogoClient-side

Solicitud

Obtiene un juego para el catálogo.

Nota

Este punto final, accesible sin autorización, devuelve datos genéricos. Sin embargo, la autorización enriquece la respuesta con detalles específicos del usuario para obtener un resultado personalizado, como los límites de usuario y las promociones disponibles.
Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

ID del proyecto. Encontrará este parámetro en su Cuenta del editor junto al nombre del proyecto.

Ejemplo: 44056
item_skustringrequerido

SKU del artículo.

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

La lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud.

Elementos Enumeración"media_list""order""long_description""custom_attributes""item_order_in_group"
countrystring

Código de país de dos letras mayúsculas de conformidad con la norma ISO 3166-1 alpha-2. Consulte la documentación para obtener información detallada sobre los países admitidos por Xsolla y el proceso de determinación del país.

Ejemplo: country=US
promo_codestring[ 1 .. 128 ] characters

Código único que distingue entre mayúsculas y minúsculas. Contiene letras y números.

Ejemplo: promo_code=WINTER2021
show_inactive_time_limited_itemsinteger

Muestra los artículos de duración limitada que no están disponibles para el usuario. El periodo de validez de dichos artículos no ha comenzado o ya ha expirado.

Predeterminado 0
Ejemplo: show_inactive_time_limited_items=1
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/items/game/sku/{item_sku}?locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

El juego se recibió correctamente.

Cuerpoapplication/json
attributesArray of objects(Game-Keys_schemas-client-attributes)

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

Predeterminado []
Ejemplo: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
descriptionstring

Descripción del artículo.

Ejemplo: "Game description"
groupsArray of objects(items_client_groups_response)

Grupos a los que pertenece el artículo.

Predeterminado []
Ejemplo: [{"external_id":"exclusive","name":"Exclusive"}]
image_urlstring

URL de la imagen.

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

Nombre del artículo.

Ejemplo: "Game name"
promotionsArray of objects(Catalog_item_promotions)

Promociones aplicadas para artículos específicos de la cesta. La matriz se devuelve en los siguientes casos:

  • Se configura un descuento promocional para un artículo específico.

  • Se aplica un código promocional con el parámetro Descuento en artículos seleccionados.

Si no se aplican promociones a nivel de artículo, se devuelve una matriz vacía.

skustring

ID único del artículo. El SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

Ejemplo: "game_01"
typestring

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

Ejemplo: "unit"
unit_itemsArray of objects
unit_typestring

Tipo de unidad: game.

Ejemplo: "game"
Respuesta
application/json
{
  "attributes": [
    { … },
    { … }
  ],
  "description": "Game description",
  "groups": [
    { … },
    { … }
  ],
  "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
  "name": "Game name",
  "promotions": [],
  "sku": "com.xsolla.game_1",
  "type": "unit",
  "unit_items": [
    { … },
    { … }
  ],
  "unit_type": "game"
}

Derechos

Operaciones

Admin

Operaciones

Común

Operaciones

Cupones

Esta API le permite gestionar cupones.

Operaciones

Códigos promocionales

Esta API permite gestionar códigos promocionales.

Operaciones

Ofertas únicas por catálogo

Esta API le permite gestionar ofertas de catálogo únicas.

Operaciones

Descuentos

Esta API le permite gestionar promociones de descuento.

Operaciones

Bonificaciones

Esta API permite gestionar promociones de bonificaciones.

Operaciones

Admin

Operaciones

Catálogo

Operaciones

Pago virtual

Operaciones

Gestión

Operaciones

Admin

Operaciones

Cliente

Operaciones

Cliente de clanes

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones