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

Obtener el saldo de puntos de valor del usuario actualClient-side

Solicitud

Punto final del cliente. Obtiene el saldo de puntos de valor del usuario actual.

Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
reward_chain_idintegerrequerido

ID de la cadena de recompensas.

Ejemplo: 101
curl -i -X GET \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/user/reward_chain/101/balance \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

Se recuperó correctamente el saldo de puntos de valor del usuario.

Cuerpoapplication/json
amountinteger

Cantidad de puntos de valor.

descriptionstring or null(value-point-description)

Descripción del punto de valor.

image_urlstring(Common_admin-image_url)

URL de la imagen.

Ejemplo: "https://image.example.com"
is_clanboolean(is_clan)

Si el punto de valor se utiliza en las cadenas de recompensas de clanes.

Ejemplo: true
long_descriptionstring or null(value-point-long-description)

Descripción larga del punto de valor.

namestring(value-point-name)

Nombre del punto de valor.

skustring(value-point-sku)

ID único del punto de valor.

Respuesta
application/json
{ "amount": 80, "description": "Value points for clan reward system.", "image_url": "https://cdn.xsolla.net/img/misc/images/5c3b8b45c5be5fe7803e59fbc8041be4.png", "is_clan": true, "long_description": "Value points given to clans to get new rewards in a reward chain.", "name": "Clan Reward VP 1", "sku": "com.xsolla.clan_value_point_1" }

Reclamar recompensa por pasoClient-side

Solicitud

Punto final del cliente. Reclama la recompensa por paso del usuario actual de una cadena de recompensas.

Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
reward_chain_idintegerrequerido

ID de la cadena de recompensas.

Ejemplo: 101
step_idintegerrequerido

ID del paso de la cadena de recompensas.

Ejemplo: 120
curl -i -X POST \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/user/reward_chain/101/step/120/claim \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

Ha reclamado correctamente la recompensa por paso del usuario actual de una cadena de recompensas.

Respuesta
Sin contenido
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones