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

Obtener información sobre la configuración de webhooksServer-sideAdmin

Solicitud

Obtiene la información sobre la configuración de webhooks en Store. Consulte la documentación de webhooks para obtener más información.

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

Respuestas

La información sobre la configuración de webhooks se recibió correctamente.

Cuerpoapplication/json
is_enabledboolean
Ejemplo: true
secretstring
Ejemplo: "my_secret"
urlstring
Ejemplo: "http://site.ru/webhook"
Respuesta
application/json
{ "is_enabled": true, "secret": "my_secret", "url": "http://site.ru/webhook" }

Actualizar la información sobre la configuración de webhooksServer-sideAdmin

Solicitud

Actualiza la información sobre la configuración de webhooks en Store. Consulte la documentación de webhooks para obtener más información.

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

Información sobre la configuración de webhooks.

is_enabledbooleanrequerido

Si están habilitados los webhooks de Game services.

Para los webhooks Game services, la configuración especificada en esta llamada API tiene prioridad sobre la configuración establecida en Cuenta del editor en la sección Project Settings > Webhooks.

Ejemplo: true
secretstringrequerido

La clave secreta del proyecto para firmar los webhooks de Game services.

Para Game services, la clave especificada en esta llamada API tiene prioridad sobre la clave generada en Cuenta del editor en la sección Project Settings > Webhooks.

Ejemplo: "my_secret_key"
urlstringrequerido

URL de su servidor para recibir webhooks de Game services. La URL debe ser de acceso público y usar el protocolo HTTPS; por ejemplo https://example.com. También puede especificar la URL que encuentre en cualquier herramienta para probar webhooks.

Para los webhooks Game services, la configuración especificada en esta llamada API tiene prioridad sobre la configuración establecida en Cuenta del editor en la sección Project Settings > Webhook.

Ejemplo: "http://site.ru/webhook"
versioninteger

Versión de webhooks. En la versión 2, la matriz items incluye los parámetros is_free, is_bonus y is_bundle_content, los cuales no están presentes en la versión 1 (por defecto).

Enumeración12
Ejemplo: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "secret": "my_secret_key",
    "url": "http://site.ru/webhook",
    "version": 1
  }'

Respuestas

La información sobre la configuración de webhooks se actualizó correctamente.

Respuesta
Sin contenido
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