Saltar al contenido

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

Descargar descripción de OpenAPI
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/shop-builder/
https://store.xsolla.com/api/
Operaciones

Catálogo personalizado

Esta API permite especificar reglas para los atributos de usuario. Si el usuario cumple todas las condiciones de una regla específica, se mostrarán los elementos personalizados.

Para promociones personalizadas, consulte la sección Promotions.

Para transmitir atributos antes de una compra, puede utilizar Xsolla Login API o transmitirlos a la propiedad user.attributes mientras se genera el token utilizando Pay Station API.

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

Obtener lista de regionesServer-sideAdmin

Solicitud

Obtiene la lista de regiones.

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
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/region

Respuestas

La lista de regiones se recibió correctamente.

Cuerpoapplication/json
regionsArray of objects(Regions_200-region-short-model)
Respuesta
application/json
{ "regions": [ {}, {} ] }

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://xsolla.redocly.app/_mock/es/api/shop-builder/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://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/region/42

Respuestas

La región se eliminó correctamente.

Cuerpo
Respuesta
Sin contenido
Operaciones
Operaciones
Operaciones
Operaciones

Cupones

Esta API le permite gestionar cupones.

Operaciones

Códigos promocionales

Esta API permite gestionar códigos promocionales.

Operaciones

Ofertas únicas por catálogo

Esta API le permite gestionar ofertas de catálogo únicas.

Operaciones

Descuentos

Esta API le permite gestionar promociones de descuento.

Operaciones

Bonificaciones

Esta API permite gestionar promociones de bonificaciones.

Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones