Saltar al contenido
/
Obtener la lista de paque...

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

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

Obtener lista de monedas virtualesClient-side

Solicitud

Obtiene una lista de monedas virtuales para crear un catálogo.

Atención

Todos los proyectos tienen la limitación de número de artículos que se pueden obtener en la respuesta. El valor por defecto y máximo es de 50 artículos por respuesta. Para obtener más datos, página por página, utilice los campos limit y offset.

Nota

El uso de las llamadas API del catálogo de artículos está disponible sin autorización, pero para obtener un catálogo personalizado, debe transmitir el JWT de usuario en el encabezado Authorization.
Seguridad
XsollaLoginUserJWT
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
localestring

Idioma de respuesta. Código de idioma de dos letras minúsculas según la norma ISO 639-1.

Predeterminado "en"
additional_fields[]Array of strings

La lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud.

Elementos Enumeración"media_list""order""long_description""custom_attributes""item_order_in_group"
countrystring

Código de país de dos letras mayúsculas 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 y el proceso de determinación del país.

Ejemplo: country=US
promo_codestring[ 1 .. 128 ] characters

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

Ejemplo: promo_code=WINTER2021
show_inactive_time_limited_itemsinteger

Muestra los artículos de duración limitada que no están disponibles para el usuario. El periodo de validez de dichos artículos no ha comenzado o ya ha expirado.

Predeterminado 0
Ejemplo: show_inactive_time_limited_items=1
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/items/virtual_currency?limit=50&offset=0&locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

La lista de monedas virtuales se recibió correctamente.

Cuerpoapplication/json
has_moreboolean(Pagination_has-more)

Se utiliza como indicador de que hay más páginas.

Ejemplo: true
itemsArray of objects(Virtual-Items-Currency_virtual-currency)
Respuesta
application/json
{
  "has_more": false,
  "items": [
    { … },
    { … },
    { … }
  ]
}

Obtener la lista de paquetes de moneda virtualClient-side

Solicitud

Obtiene una lista de paquetes de moneda virtual para crear un catálogo.

Atención

Todos los proyectos tienen la limitación de número de artículos que se pueden obtener en la respuesta. El valor por defecto y máximo es de 50 artículos por respuesta. Para obtener más datos, página por página, utilice los campos limit y offset.

Nota

El uso de las llamadas API del catálogo de artículos está disponible sin autorización, pero para obtener un catálogo personalizado, debe transmitir el JWT de usuario en el encabezado Authorization.
Seguridad
XsollaLoginUserJWT
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
localestring

Idioma de respuesta. Código de idioma de dos letras minúsculas según la norma ISO 639-1.

Predeterminado "en"
additional_fields[]Array of strings

La lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud.

Elementos Enumeración"media_list""order""long_description""custom_attributes""item_order_in_group"
countrystring

Código de país de dos letras mayúsculas 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 y el proceso de determinación del país.

Ejemplo: country=US
promo_codestring[ 1 .. 128 ] characters

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

Ejemplo: promo_code=WINTER2021
show_inactive_time_limited_itemsinteger

Muestra los artículos de duración limitada que no están disponibles para el usuario. El periodo de validez de dichos artículos no ha comenzado o ya ha expirado.

Predeterminado 0
Ejemplo: show_inactive_time_limited_items=1
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/items/virtual_currency/package?limit=50&offset=0&locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

La lista de paquetes de moneda virtual se recibió correctamente.

Cuerpoapplication/json
has_moreboolean(Pagination_has-more)

Se utiliza como indicador de que hay más páginas.

Ejemplo: true
itemsArray of objects(Virtual-Items-Currency_virtual-currency-package)
Respuesta
application/json
{
  "has_more": false,
  "items": [
    { … },
    { … }
  ]
}

Obtener paquete de moneda virtual por SKUClient-side

Solicitud

Obtiene paquetes de moneda virtual por SKU para crear un catálogo.

Nota

Este punto final, accesible sin autorización, devuelve datos genéricos. Sin embargo, la autorización enriquece la respuesta con detalles específicos del usuario para un resultado personalizado, como los límites de usuario y las promociones disponibles.
Seguridad
XsollaLoginUserJWT
Ruta
project_idintegerrequerido

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

Ejemplo: 44056
virtual_currency_package_skustringrequerido

SKU del paquete de moneda virtual.

Ejemplo: crystal-pack
Consulta
localestring

Idioma de respuesta. Código de idioma de dos letras minúsculas según la norma ISO 639-1.

Predeterminado "en"
countrystring

Código de país de dos letras mayúsculas 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 y el proceso de determinación del país.

Ejemplo: country=US
show_inactive_time_limited_itemsinteger

Muestra los artículos de duración limitada que no están disponibles para el usuario. El periodo de validez de dichos artículos no ha comenzado o ya ha expirado.

Predeterminado 0
Ejemplo: show_inactive_time_limited_items=1
additional_fields[]Array of strings

La lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud.

Elementos Enumeración"media_list""order""long_description""custom_attributes""item_order_in_group"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/items/virtual_currency/package/sku/crystal-pack?locale=en&country=US&show_inactive_time_limited_items=1&additional_fields%5B%5D=media_list' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

El paquete de moneda virtual se recibió correctamente.

Cuerpoapplication/json
attributesArray of objects(Virtual-Items-Currency_client-attributes)

Lista de atributos y sus valores correspondientes al artículo. Puede utilizarse para filtrar el catálogo.

Predeterminado []
Ejemplo: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
bundle_typestring

Tipo de lote: standard/virtual_currency_package.

Ejemplo: "virtual_currency_package"
can_be_boughtboolean(Can_be_bought)

Si es true, el usuario puede comprar un artículo.

Ejemplo: true
contentArray of objects

Contenido del paquete de moneda virtual.

Ejemplo: [{"description":"Crystal Pack - short description","image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","name":"Crystal Pack","quantity":100,"sku":"com.xsolla.crystal_pack_1","type":"virtual_currency"}]
custom_attributesobject(json)(item-custom-attributes-response)

Un objeto JSON que contiene los atributos y valores del artículo.

descriptionstring

Descripción del artículo.

Ejemplo: "Crystal Pack Description"
groupsArray of objects(items_client_groups_response)

Grupos a los que pertenece el artículo.

Predeterminado []
Ejemplo: [{"external_id":"exclusive","name":"Exclusive"}]
image_urlstring

URL de la imagen.

Ejemplo: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
is_freeboolean(value-is_free)

Si es true, el artículo es gratuito.

Predeterminado false
Ejemplo: false
item_idinteger
limitsobject or null(Catalog_item_limits)

Límites del artículo.

namestring

Nombre del artículo.

Ejemplo: "Crystal Pack"
periodsArray of objects(item-periods-response)

Periodo de venta del artículo.

priceobject

Precios de artículos.

promotionsArray of objects(Catalog_item_promotions)

Promociones aplicadas para artículos específicos de la cesta. La matriz se devuelve en los siguientes casos:

  • Se configura un descuento promocional para un artículo específico.

  • Se aplica un código promocional con el parámetro Descuento en artículos seleccionados.

Si no se aplican promociones a nivel de artículo, se devuelve una matriz vacía.

skustring

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: "crystal-pack"
typestring

Tipo de artículo: virtual_good/virtual_currency/bundle.

Ejemplo: "bundle"
virtual_pricesArray of objects

Precios virtuales.

vp_rewardsArray of arrays
Respuesta
application/json
{
  "attributes": [],
  "bundle_type": "virtual_currency_package",
  "can_be_bought": true,
  "content": [
    { … }
  ],
  "custom_attributes": {
    "attr": "value",
    "purchased": 0
  },
  "description": "Crystal Pack Short Description",
  "groups": [],
  "image_url": "http://vc_package_image.png",
  "is_free": false,
  "item_id": 488832,
  "limits": {
    "per_item": null,
    "per_user": { … }
  },
  "name": "Crystal Pack",
  "periods": [
    { … }
  ],
  "price": {
    "amount": "100",
    "amount_without_discount": "100",
    "currency": "USD"
  },
  "promotions": [],
  "sku": "com.xsolla.crystal_pack_1",
  "type": "bundle",
  "virtual_prices": [],
  "vp_rewards": []
}

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