Saltar al contenido

Shop Builder API (2.0.0)

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

Admin

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

Obtener lista de reglas de filtrado del catálogoServer-sideAdmin

Solicitud

Obtiene todas las reglas que se aplican a los atributos de usuario.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
Consulta
limitinteger>= 1

Límite para el número de elementos presentes en la página.

Ejemplo: limit=50
offsetinteger>= 0

Número del elemento a partir del cual se genera la lista (el conteo empieza desde el 0).

Ejemplo: offset=0
is_enabledinteger

Filtrar elementos por la marca is_enabled.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/user/attribute/rule?limit=50&offset=0&is_enabled=0'

Respuestas

Las reglas se recibieron correctamente.

Cuerpoapplication/json
has_moreboolean

Si existe otra página con reglas.

itemsArray of objects(user-attribute_personalized-catalog)
total_items_countnumber

Número total de reglas.

Respuesta
application/json
{
  "has_more": true,
  "items": [
    { … }
  ],
  "total_items_count": 20
}

Crear regla de filtrado del catálogoServer-sideAdmin

Solicitud

Crear regla para atributos de usuario.

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
attribute_conditionsArray of tipo = string (object) or tipo = number (object) or tipo = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] itemsrequerido

Condiciones para validar los atributos de usuario. Determina la disponibilidad de artículos en el catálogo en función de si los atributos de usuario cumplen todas las condiciones especificadas.

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$requerido

Código de atributo de usuario.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

Indica que se cumple la condición aunque falte el atributo en los atributos del usuario. Transmita true para mostrar el elemento a los usuarios que no tengan este atributo. Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, no verán el artículo. false - Los usuarios que tengan el atributo, pero el valor no coincida con el especificado en la condición, o falte el atributo, no verán el artículo.

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)requerido

Tipo de operación realizada por condición. Para el tipo de atributo string.

Enumeración ValorDescripción
eq

Igual que

ne

No es igual que

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)requerido

Tipo de atributo de usuario.

Valor"string"
attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 charactersrequerido

Valor de la condición con el que se comparará el valor de atributo del usuario. El tipo depende del tipo de atributo.

is_enabledbooleanrequerido

Si la regla está habilitada.

is_satisfied_for_unauthboolean

Si el artículo se muestra a usuarios no autorizados. Si es true, el artículo se muestra al usuario no autorizado independientemente de las reglas de visualización del catálogo. Es false por defecto.

itemsArray of objects[ 1 .. 100 ] itemsrequerido
One of:

Artículos que se muestran a un usuario si sus valores de atributos cumplen unas condiciones.

items[].​item_idnumberrequerido

ID del artículo.

namestring[ 1 .. 255 ] characters^\Srequerido

Nombre legible de una regla. Se utiliza para visualizar una regla en Cuenta del editor.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/user/attribute/rule \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "race",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "ork"
      }
    ],
    "is_enabled": true,
    "is_satisfied_for_unauth": false,
    "items": [
      {
        "item_id": 1
      }
    ],
    "name": "Ork race armor rule"
  }'

Respuestas

La regla se creó correctamente.

Cuerpoapplication/json
rule_idnumber

ID de regla.

Respuesta
application/json
{
  "rule_id": 1
}

Obtener todas las reglas del catálogo para la búsqueda en el lado del clienteServer-sideAdmin

Solicitud

Obtiene una lista de todas las reglas del catálogo para buscar en el lado del cliente.

Atención

Devuelve solo el ID de la regla, el nombre y is_enabled
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/user/attribute/rule/all

Respuestas

Las reglas se recibieron correctamente.

Cuerpoapplication/json
itemsArray of objects(user-attribute_personalized-catalog_all)
Respuesta
application/json
{
  "items": [
    { … },
    { … }
  ]
}

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

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

Catálogo

Operaciones

Derechos

Operaciones

Admin

Operaciones

Común

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

Admin

Operaciones

Catálogo

Operaciones

Pago virtual

Operaciones

Gestión

Operaciones

Admin

Operaciones

Cliente

Operaciones

Cliente de clanes

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones

Cliente

Operaciones

Admin

Operaciones