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

Desactivar promoción de cuponesServer-sideAdmin

Solicitud

Desactiva una promoción de cupones. La promoción de cupones creada está deshabilitada por defecto. No estará lista para su canje hasta que la active. Utilice este punto final para deshabilitar y desactivar una promoción de cupones.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
external_idintegerrequerido

ID externo de la promoción. Identificador único de la promoción dentro del proyecto.

Ejemplo: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/coupon/coupon_44056_1/deactivate

Respuestas

El cupón se desactivó correctamente.

Respuesta
Sin contenido

Obtener el límite de cupones para un usuario especificadoServer-sideAdmin

Solicitud

Obtiene el número restante de veces que el usuario especificado puede utilizar el cupón.

La API de límite del usuario le permite limitar el número de veces que los usuarios pueden utilizar un cupón. Para configurar este límite de usuario, vaya a Admin:

Seguridad
basicAuth
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
external_idintegerrequerido

ID externo de la promoción. Identificador único de la promoción dentro del proyecto.

Ejemplo: coupon_44056_1
Consulta
user_external_idstringrequerido

ID externo del usuario

Ejemplo: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/user/limit/coupon/external_id/coupon_44056_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Respuestas

Se recibieron correctamente los límites de cupón para un usuario.

Cuerpoapplication/json
per_userobject
Respuesta
application/json
{ "per_user": { "available": 9, "total": 10 } }

Consigue recompensas en forma de cuponesClient-side

Solicitud

Obtiene las recompensas en forma de cupones por su código. Puede utilizarse para permitir a los usuarios elegir uno de varios artículos como bonificación. El caso más habitual es elegir un DRM (gestión de derechos digitales) si el cupón contiene un juego como bonificación (type=unit).

Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
coupon_codestring[ 1 .. 128 ] charactersrequerido

Código único que distingue entre mayúsculas y minúsculas. Contiene letras y números.

Ejemplo: WINTER2021
curl -i -X GET \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/coupon/code/WINTER2021/rewards \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

La lista de recompensas de cupones se recibió correctamente.

Cuerpoapplication/json
bonusArray of objects(Promotions_200-coupon-bonus-reward)
discountobject or null(Promotions_200-coupon-discount-reward)

Porcentaje de descuento. El precio de la cesta se reducirá utilizando un valor calculado utilizando este porcentaje y luego se redondeará al segundo decimal.

is_selectableboolean

Si es true, el usuario debe elegir la bonificación antes de canjear un cupón.

Respuesta
application/json
{ "bonus": [ {}, {} ], "discount": { "percent": "10.00" }, "is_selectable": true }

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