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

Crear token de pago para la compraServer-side

Solicitud

Genera un pedido y un token de pago para el mismo. El pedido se genera en función de los artículos transmitidos en el cuerpo de la solicitud.

Para abrir la interfaz de usuario para pagos en una nueva ventana, utilice el siguiente enlace: https://secure.xsolla.com/paystation4/?token={token}, en el cual {token} es el token recibido.

Para realizar pruebas, utilice esta URL: https://sandbox-secure.xsolla.com/paystation4/?token={token}.

Aviso

El parámetro user.country.value se usa para seleccionar una moneda para el pedido. Si se desconoce el país del usuario, otra opción es proporcionar la IP del usuario en el encabezado X-User-Ip.
Se requiere una de estas dos opciones para el correcto funcionamiento de este método.
La moneda seleccionada se usa para los métodos de pago en Pay Station.
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
custom_parametersobject or null(Cart-Payment_custom_parameters)[ 1 .. 200 ] properties

Sus parámetros personalizados representados como un conjunto JSON válido de pares clave-valor.
Puede transmitir parámetros adicionales a través de este campo para configurar filtros antifraude. Consulte la documentación de Pay Station.

Ejemplo: {"custom_parameters":{"bool_param":true,"int_param":100,"null_param":null,"string_param":"example"}}
promo_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

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

Predeterminado "WINTER2021"
Ejemplo: "WINTER2021"
purchaseobject(Cart_admin_payment)requerido
purchase.​itemsArray of objectsnon-emptyrequerido
purchase.​items[].​quantitynumber>= 1requerido

Cantidad del artículo.

Ejemplo: 2
purchase.​items[].​skustringnon-emptyrequerido

ID único del artículo. El SKU solo puede contener caracteres alfanuméricos latinos en minúsculas y mayúsculas, puntos, guiones y guiones bajos.

Ejemplo: "t-shirt"
sandboxboolean(Cart-Payment_settings_sandbox)

Seleccione true para probar el proceso de pago. En este caso, utilice https://sandbox-secure.xsolla.com para acceder a la interfaz de pago de prueba.

Predeterminado false
settingsobject

Configuración del proceso de pago y de la interfaz de pago para un usuario.

userobject(Cart-Payment_admin-user-request-body)requerido
user.​ageinteger

Edad del usuario.

user.​countryobject
user.​emailobject
user.​idobjectrequerido
user.​id.​valuestring[ 1 .. 255 ] characters

ID de usuario. Para realizar pruebas, puede transmitir cualquier valor. Para aceptar pagos reales, debe usar el valor de ID de usuario de su sistema. Este ID se transmite en el webhook Validación del usuario.

user.​is_legalboolean

Si el usuario es una entidad jurídica.

user.​legalobject

Objeto con datos de la entidad jurídica. El objeto y todos sus parámetros son obligatorios si user.is_legal es true.

user.​nameobject
user.​phoneobject
user.​steam_idobject
user.​tracking_idobject
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v3/project/44056/admin/payment/token \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "items": [
        {
          "quantity": 2,
          "sku": "com.xsolla.cup01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.t-shirt01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.cup01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.hat01"
        }
      ]
    },
    "settings": {
      "currency": "USD",
      "external_id": "AABBCCDD01",
      "language": "de",
      "payment_method": 1380,
      "return_url": "https://developers.xsolla.com/es/",
      "ui": {
        "theme": "63295aab2e47fab76f7708e3"
      }
    },
    "user": {
      "country": {
        "allow_modify": false,
        "value": "US"
      },
      "email": {
        "value": "user@xsolla.com"
      },
      "id": {
        "value": "user-id"
      },
      "name": {
        "value": "user-name"
      }
    }
  }'

Respuestas

Token de pago y pedido creados correctamente.

Cuerpoapplication/json
order_idinteger

ID del pedido.

Ejemplo: 1
tokenstring

Token de pago.

Respuesta
application/json
{ "order_id": 12345, "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb" }
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
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones
Operaciones