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

Solicitud

Crea una región.

Puede utilizar una región para gestionar sus restricciones regionales.

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
countriesArray of strings(Regions_countries)requerido

Lista de países que se añadirán en una región.
Código de país de dos letras en mayúscula 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.
Ejemplo: ["JP", "CN", "VN"]

nameobject(Regions_name)requerido

Nombre de la región. Debe contener pares clave/valor en los cuales la clave es una configuración regional con el formato "^[a-z]{2}-[A-Z]{2}$", el valor es una cadena (string).

Predeterminado {"de-DE":"Asien","en-US":"Asia"}
Ejemplo: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*stringpropiedad adicional
curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/region \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

Respuestas

La región se creó correctamente.

Cuerpoapplication/json
region_idinteger(Regions_region_id)

ID de región. Identificador único de región dentro del proyecto.

Ejemplo: 42
Respuesta
application/json
{ "region_id": 42 }

Solicitud

Elimina una región concreta.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
region_idintegerrequerido

ID de región. Identificador único de región dentro del proyecto.

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

Respuestas

La región se eliminó correctamente.

Cuerpo
Respuesta
Sin contenido

Solicitud

Obtiene una región concreta.

Puede utilizar una región para gestionar sus restricciones regionales.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
region_idintegerrequerido

ID de región. Identificador único de región dentro del proyecto.

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

Respuestas

La región especificada se recibió correctamente.

Cuerpoapplication/json
countriesArray of strings(Regions_countries)

Lista de países que se añadirán en una región.
Código de país de dos letras en mayúscula 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.
Ejemplo: ["JP", "CN", "VN"]

idinteger(Regions_region_id)

ID de región. Identificador único de región dentro del proyecto.

Ejemplo: 42
nameobject(Regions_name)

Nombre de la región. Debe contener pares clave/valor en los cuales la clave es una configuración regional con el formato "^[a-z]{2}-[A-Z]{2}$", el valor es una cadena (string).

Predeterminado {"de-DE":"Asien","en-US":"Asia"}
Ejemplo: {"de-DE":"Asien","en-US":"Asia"}
Respuesta
application/json
{ "value": { "countries": [], "id": 44, "name": {} } }
Operaciones