Saltar al contenido

Descripción general

La API de catálogo le permite configurar un catálogo de artículos de juego en el lado de Xsolla y mostrar dicho catálogo a los usuarios de su tienda.

La API le permite gestionar las siguientes entidades de catálogo:

  • Artículos virtuales: artículos de juego, como armas, apariencias o potenciadores.
  • Moneda virtual: dinero virtual que se utiliza para comprar productos virtuales.
  • Paquetes de moneda virtual: lotes predefinidos de moneda virtual.
  • Lotes: paquetes combinados de artículos virtuales, moneda o claves de juego que se venden como un único SKU.
  • Claves de juego: claves para juegos y DLC distribuidos a través de plataformas como Steam u otros proveedores de DRM.
  • Grupos: agrupaciones lógicas para organizar y clasificar artículos dentro del catálogo.

Llamadas API

La API se divide en los siguientes grupos:

  • Admin: llamadas para crear, actualizar, eliminar y configurar artículos de catálogo y grupos. La autenticación se realiza mediante autenticación de acceso básica con sus credenciales de comerciante o de proyecto. No está diseñado para uso en escaparates.
  • Catalog: llamadas para buscar artículos y crear escaparates personalizados para los usuarios finales. Diseñado para gestionar situaciones de alta carga. Admite la autorización JWT opcional de usuarios para devolver datos personalizados, como límites específicos para determinados usuarios y promociones activas.
Descargar descripción de OpenAPI
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/es/api/catalog/
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones

Obtener cesta por el ID de la cestaClient-side

Solicitud

Devuelve la cesta del usuario por el ID de la cesta.

Seguridad
AuthForCart
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
cart_idstringrequerido

ID de la cesta.

Ejemplo: custom_id
Consulta
currencystring

Moneda en la que se muestra el precio del artículo en la cesta. Código de moneda de tres letras según ISO 4217. Consulte la documentación para obtener información detallada sobre monedas soportadas por Xsolla.

Predeterminado "USD"
localestring

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

Predeterminado "en"
curl -i -X GET \
  'https://store.xsolla.com/api/v2/project/44056/cart/custom_id?currency=USD&locale=en' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

La cesta con artículos se devolvió correctamente.

Cuerpoapplication/json
cart_idstring

ID de la cesta.

Ejemplo: "cart_id"
is_freeboolean(value-cart_is_free)

Si true, la cesta es gratuita.

Predeterminado false
Ejemplo: false
itemsArray of objects
priceobject or null

Precio de la cesta.

Ejemplo: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
promotionsArray of objects(Catalog_cart_promotions)

Promociones aplicadas a toda la cesta. La matriz se devuelve en los siguientes casos:

  • Una promoción afecta al importe total de la cesta, como un código promocional con el parámetro Descuento en la compra.

  • Una promoción añade artículos de bonificación a la cesta.

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

Respuesta
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {} ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ] }

Eliminar todos los artículos de la cesta por el ID de la cestaClient-side

Solicitud

Elimina todos los artículos de la cesta.

Seguridad
AuthForCart
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
cart_idstringrequerido

ID de la cesta.

Ejemplo: custom_id
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/cart/custom_id/clear \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Respuestas

La cesta se vació correctamente.

Llenar la cesta específica con artículosClient-side

Solicitud

Llena la cesta específica con artículos. Si la cesta ya contiene un artículo con el mismo SKU, la posición del artículo existente se sustituirá por el valor transmitido.

Seguridad
AuthForCart
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
cart_idstringrequerido

ID de la cesta.

Ejemplo: custom_id
Cuerpoapplication/json
itemsArray of objectsrequerido

Lista de artículos.

Ejemplo: [{"quantity":123,"sku":"com.xsolla.booster_mega_1"}]
items[].​quantitynumberrequerido
Predeterminado 123
items[].​skustringrequerido
Predeterminado "booster_mega_1"
curl -i -X PUT \
  https://store.xsolla.com/api/v2/project/44056/cart/custom_id/fill \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "items": [
      {
        "quantity": 123,
        "sku": "com.xsolla.booster_mega_1"
      }
    ]
  }'

Respuestas

La cesta con artículos se devolvió correctamente.

Cuerpoapplication/json
cart_idstring

ID de la cesta.

Ejemplo: "cart_id"
is_freeboolean(value-cart_is_free)

Si true, la cesta es gratuita.

Predeterminado false
Ejemplo: false
itemsArray of objects
priceobject or null

Precio de la cesta.

Ejemplo: {"amount":"6150.0000000000000000","amount_without_discount":"6150.0000000000000000","currency":"USD"}
promotionsArray of objects(Catalog_cart_promotions)

Promociones aplicadas a toda la cesta. La matriz se devuelve en los siguientes casos:

  • Una promoción afecta al importe total de la cesta, como un código promocional con el parámetro Descuento en la compra.

  • Una promoción añade artículos de bonificación a la cesta.

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

warningsArray of objects
Respuesta
application/json
{ "cart_id": "cart_id", "is_free": false, "items": [ {} ], "price": { "amount": "6150.0000000000000000", "amount_without_discount": "6150.0000000000000000", "currency": "USD" }, "promotions": [ {} ], "warnings": [ {} ] }
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones

Catálogo

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

Operaciones
Operaciones
Operaciones