Saltar al contenido
/
Adjuntar campaña a la pro...

Subscriptions API (2.0)

Información general

  • Versión: 2.0
  • Servidores: https://api.xsolla.com/merchant/v2/

Esta referencia de API describe los extremos para administrar suscripciones, cupones y promociones. Para obtener más información sobre las suscripciones, consulta la página guía del producto y el glosario.

Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
Mock server
https://xsolla.redocly.app/_mock/es/api/subscriptions/

Token

Operaciones

Planes

Operaciones

Productos

Operaciones

Subscription management

Operaciones

Pagos

Operaciones

Promociones

Operaciones

Cupones

Operaciones

Añadir cupón a la campaña

Solicitud

Agregue un código de cupón a una campaña de cupones.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

campaign_idintegerrequerido

ID de campaña.

Cuerpoapplication/jsonrequerido
coupon_codestringrequerido

Código de cupón.

Ejemplo: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

Respuestas

No content (Sin contenido).

Adjuntar campaña a la promoción

Solicitud

Adjunte una campaña de cupones a una promoción específica.

Aviso

Esta llamada API no contiene el parámetro de ruta project_id, por lo que tiene que usar la clave de API que sea válida en todos los proyectos de la empresa para establecer la autorización.

Seguridad
basicAuth
Ruta
merchant_idintegerrequerido

ID de vendedor.

promotion_idintegerrequerido

ID de promoción.

Cuerpoapplication/jsonrequerido
campaignsArray of integersrequerido

Matriz de ID de campañas.

Ejemplo: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

Respuestas

No content (Sin contenido).

Obtener cupón

Solicitud

Obtén los detalles del cupón mediante su código.

Seguridad
basicAuth
Ruta
project_idintegerrequerido

ID de proyecto.

codestringrequerido

Código de cupón.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/projects/{project_id}/coupons/{code}/details'

Respuestas

ACEPTAR.

Cuerpoapplication/json
keystring

Clave del atributo de usuario.

list_of_valuesArray of objects

Matriz de valores posibles para el tipo enum.

nameobject

Nombres de atributos localizados.

skip_condition_on_nonexistent_keyboolean

Si se omite la condición si la clave no existe.

typestring

Tipo de clave.

Enumeración"int""string""enum""date"
visibleboolean
Respuesta
application/json
{
  "key": "12",
  "list_of_values": [],
  "name": {
    "en": "Level",
    "ru": "Уровень"
  },
  "skip_condition_on_nonexistent_key": true,
  "type": "int",
  "visible": false
}

Subscription management

Operaciones