Saltar al contenido
/
Reducir el número de artí...

API de catálogo (2.0.0)

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
index.json
index.yaml
Idiomas
Servidores
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/es/api/catalog/

Admin

Operaciones

Catálogo

Operaciones

Pago virtual

Operaciones

Catálogo

Operaciones

Derechos

Operaciones

Admin

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

Gestión

Operaciones

Actualizar todos los límites de compra para un usuario especificadoServer-sideAdmin

Solicitud

Actualiza todos los límites de compra de todos los artículos para un usuario especificado para que pueda comprar estos artículos de nuevo.

La API de límite del usuario le permite vender un artículo en una cantidad limitada. Para configurar los límites de compra, vaya a Admin del módulo del tipo de artículo deseado:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
Cuerpoapplication/json
userobject(User-limit_user)requerido
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$requerido

ID externo del usuario.

curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respuestas

El límite se actualizó correctamente.

Respuesta
Sin contenido

Reducir el número de artículos disponibles para un usuario especificadoServer-sideAdmin

Solicitud

Reduce el número restante de artículos disponibles para el usuario especificado dentro del límite aplicado.

La API de límite del usuario le permite vender un artículo en una cantidad limitada. Para configurar los límites de compra, vaya a Admin del módulo del tipo de artículo deseado:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
item_skustringrequerido

Código (SKU) del artículo.

Ejemplo: booster_mega_1
Cuerpoapplication/json
availableinteger(User-limit_available)>= 1requerido

Número restante de artículos o usos de la promoción disponibles para el usuario dentro del límite aplicado.

userobject(User-limit_user)requerido
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$requerido

ID externo del usuario.

curl -i -X DELETE \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Respuestas

Se recibieron correctamente los límites de compra para un usuario.

Cuerpoapplication/json
per_userobject
Respuesta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Obtener el número de artículos disponibles para un usuario especificadoServer-sideAdmin

Solicitud

Obtiene el número restante de artículos disponibles para el usuario especificado dentro del límite aplicado.

La API de límite del usuario le permite vender un artículo en una cantidad limitada. Para configurar los límites de compra, vaya a Admin del módulo del tipo de artículo deseado:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
item_skustringrequerido

Código (SKU) del artículo.

Ejemplo: booster_mega_1
Consulta
user_external_idstringrequerido

ID externo del usuario

Ejemplo: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/user/limit/item/sku/booster_mega_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Respuestas

Se recibieron correctamente los límites de compra para un usuario.

Cuerpoapplication/json
per_userobject
Respuesta
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Admin

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

Admin

Operaciones