Saltar al contenido
/
Obtener códigos por ID

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

Eliminar códigosServer-sideAdmin

Solicitud

Elimina todos los códigos por SKU de clave de juego.

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_emailstringrequerido

Correo del usuario.

Ejemplo: user_email=email@email.com
reasonstringrequerido

Motivo de recepción de códigos.

Ejemplo: reason=Very important
region_idinteger

ID de la región.

Predeterminado 1
curl -i -X DELETE \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/delete/sku/booster_mega_1?user_email=email%40email.com&reason=Very+important&region_id=1'

Respuestas

Los códigos se recibieron correctamente.

Cuerpotext/plain
string
Respuesta
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

Obtener códigos por IDServer-sideAdmin

Solicitud

Obtiene un determinado número de códigos por la ID de la clave del juego.

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_idstringrequerido

ID del artículo.

Ejemplo: 656
Consulta
user_emailstringrequerido

Correo del usuario.

Ejemplo: user_email=email@email.com
quantityintegerrequerido

Cantidad de códigos.

Ejemplo: quantity=100
reasonstringrequerido

Motivo de recepción de códigos.

Ejemplo: reason=Very important
region_idinteger

ID de la región.

Predeterminado 1
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/request/id/656?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

Respuestas

Los códigos se recibieron correctamente.

Cuerpotext/plain
string
Respuesta
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

Obtener códigosServer-sideAdmin

Solicitud

Obtiene un determinado número de códigos por SKU de clave de juego.

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_emailstringrequerido

Correo del usuario.

Ejemplo: user_email=email@email.com
quantityintegerrequerido

Cantidad de códigos.

Ejemplo: quantity=100
reasonstringrequerido

Motivo de recepción de códigos.

Ejemplo: reason=Very important
region_idinteger

ID de la región.

Predeterminado 1
curl -i -X GET \
  -u <username>:<password> \
  'https://store.xsolla.com/api/v2/project/44056/admin/items/game/key/request/sku/booster_mega_1?user_email=email%40email.com&quantity=100&reason=Very+important&region_id=1'

Respuestas

Los códigos se recibieron correctamente.

Cuerpotext/plain
string
Respuesta
text/plain
PIN-CODE-ALL PIN-CODE-ALL-3

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

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