Saltar al contenido
/
Revocar el derecho (admin...

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

Conceder derecho (admin)Server-sideAdmin

Solicitud

Concede el derecho al usuario.

Atención

Solo se pueden conceder códigos de juego o juegos para plataformas sin DRM (gestión de derechos digitales).
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
codestring or null

Código de juego del juego.

Ejemplo: "AAAA-BBBB-CCCC-DDDD"
drmobjectrequerido

Objeto con propiedades de DRM.

Ejemplo: {"sku":"com.xsolla.key_1"}
drm.​skustring(Game-Keys_drm_sku)requerido

ID único de DRM.

Enumeración"steam""playstation""xbox""uplay""origin""drmfree""gog""epicgames""nintendo_eshop""discord_game_store"
Ejemplo: "steam"
gameobjectrequerido

Objeto con propiedades del juego.

Ejemplo: {"sku":"com.xsolla.game_1"}
game.​skustring(Game-Keys_game_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$requerido

ID único del paquete de claves.

Ejemplo: "theGreatestGameSku"
modestringrequerido

Qué tipo de derechos deben concederse. Si el parámetro se establece en sandbox, el derecho se concederá al usuario en el modo aislador de proceso (sandbox). Si el parámetro se establece en default, el derecho se concederá al usuario en el modo real.

Enumeración"default""sandbox"
Ejemplo: "default"
user_countrystring or null

País del usuario.

Ejemplo: "US"
user_external_idstringrequerido

Identificador único de usuario.

Ejemplo: "user-external-id"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/entitlement/grant \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "AAAA-BBBB-CCCC-DDDD",
    "drm": {
      "sku": "com.xsolla.key_1"
    },
    "game": {
      "sku": "com.xsolla.game_1"
    },
    "mode": "default",
    "user_country": "US",
    "user_external_id": "user-external-id"
  }'

Respuestas

Se concedió el derecho.

Respuesta
Sin contenido

Revocar el derecho (admin)Server-sideAdmin

Solicitud

Revoca el derecho del usuario.

Atención

Solo se pueden conceder códigos de juego o juegos para plataformas sin DRM (gestión de derechos digitales).
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
drmobjectrequerido

Objeto con propiedades de DRM.

Ejemplo: {"sku":"com.xsolla.key_1"}
drm.​skustring(Game-Keys_drm_sku)requerido

ID único de DRM.

Enumeración"steam""playstation""xbox""uplay""origin""drmfree""gog""epicgames""nintendo_eshop""discord_game_store"
Ejemplo: "steam"
gameobjectrequerido

Objeto con propiedades del juego.

Ejemplo: {"sku":"com.xsolla.game_1"}
game.​skustring(Game-Keys_game_sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$requerido

ID único del paquete de claves.

Ejemplo: "theGreatestGameSku"
modestringrequerido

Qué tipo de derechos deben revocarse. Si el parámetro se establece en sandbox, el derecho se revocará al usuario en el modo aislador de proceso (sandbox). Si el parámetro se establece en default, el derecho se revocará al usuario en el modo real.

Enumeración"default""sandbox"
Ejemplo: "default"
user_external_idstringrequerido

Identificador único de usuario.

Ejemplo: "user-external-id"
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/admin/entitlement/revoke \
  -H 'Content-Type: application/json' \
  -d '{
    "drm": {
      "sku": "com.xsolla.key_1"
    },
    "game": {
      "sku": "com.xsolla.game_1"
    },
    "mode": "default",
    "user_external_id": "user-external-id"
  }'

Respuestas

Revocación realizada correctamente.

Respuesta
Sin contenido

Obtener la lista de juegos propiedad del usuarioClient-side

Solicitud

Obtiene la lista de juegos propiedad del usuario. La respuesta contendrá una matriz de juegos propiedad de un usuario concreto.

Atención

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

Qué tipo de asignación de derechos deben devolverse. Si el parámetro se establece en 1, solo se devolverán los derechos recibidos por el usuario en el modo aislador de proceso (sandbox). Si el parámetro no se transmite o se establece en 0, solo se devolverán los derechos recibidos por el usuario en el modo real.

Predeterminado 0
additional_fields[]Array of strings

Lista de campos adicionales. Estos campos estarán en la respuesta si los envía en su solicitud. attributes de campos disponibles.

curl -i -X GET \
  'https://xsolla.redocly.app/_mock/es/api/shop-builder/v2/project/44056/entitlement?limit=50&offset=0&sandbox=0&additional_fields%5B%5D=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Respuestas

La lista de claves de juego propiedad del usuario 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(Game-Keys_entitlement_item)
total_items_countinteger(Pagination_total-items-count)

Número total de artículos presentes en el sistema.

Ejemplo: 10
Respuesta
application/json
{
  "has_more": false,
  "items": [
    { … }
  ],
  "total_items_count": 1
}

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

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