Saltar al contenido

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

Admin

Operaciones

Webhooks

Operaciones

Obtener información sobre la configuración de webhooksServer-sideAdmin

Solicitud

Obtiene la información sobre la configuración de webhooks en Store. Consulte la documentación de webhooks para obtener más información.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook

Respuestas

La información sobre la configuración de webhooks se recibió correctamente.

Cuerpoapplication/json
is_enabledboolean
Ejemplo: true
secretstring
Ejemplo: "my_secret"
urlstring
Ejemplo: "http://site.ru/webhook"
Respuesta
application/json
{
  "is_enabled": true,
  "secret": "my_secret",
  "url": "http://site.ru/webhook"
}

Actualizar la información sobre la configuración de webhooksServer-sideAdmin

Solicitud

Actualiza la información sobre la configuración de webhooks en Store. Consulte la documentación de webhooks para obtener más información.

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/jsonrequerido

Información sobre la configuración de webhooks.

is_enabledbooleanrequerido

Si están habilitados los webhooks de Game services.

Para los webhooks Game services, la configuración especificada en esta llamada API tiene prioridad sobre la configuración establecida en Cuenta del editor en la sección Project Settings > Webhooks.

Ejemplo: true
secretstringrequerido

La clave secreta del proyecto para firmar los webhooks de Game services.

Para Game services, la clave especificada en esta llamada API tiene prioridad sobre la clave generada en Cuenta del editor en la sección Project Settings > Webhooks.

Ejemplo: "my_secret_key"
urlstringrequerido

URL de su servidor para recibir webhooks de Game services. La URL debe ser de acceso público y usar el protocolo HTTPS; por ejemplo https://example.com. También puede especificar la URL que encuentre en cualquier herramienta para probar webhooks.

Para los webhooks Game services, la configuración especificada en esta llamada API tiene prioridad sobre la configuración establecida en Cuenta del editor en la sección Project Settings > Webhook.

Ejemplo: "http://site.ru/webhook"
versioninteger

Versión de webhooks. En la versión 2, la matriz items incluye los parámetros is_free, is_bonus y is_bundle_content, los cuales no están presentes en la versión 1 (por defecto).

Enumeración12
Ejemplo: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "secret": "my_secret_key",
    "url": "http://site.ru/webhook",
    "version": 1
  }'

Respuestas

La información sobre la configuración de webhooks se actualizó correctamente.

Respuesta
Sin contenido

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