Saltar al contenido
/
Crear campaña

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

Crear campaña

Solicitud

Crear una nueva 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.

Cuerpoapplication/jsonrequerido
campaign_codestringrequerido

Nombre de campaña.

campaign_namesobjectrequerido

Objeto que contiene los nombres de las campañas localizados.

campaign_names.​arstring

Árabe.

campaign_names.​bgstring

Búlgaro.

campaign_names.​cnstring

Chino (simplificado).

campaign_names.​csstring

Checo.

campaign_names.​destring

Alemán.

campaign_names.​enstring

Inglés.

campaign_names.​esstring

Español.

campaign_names.​frstring

Francés.

campaign_names.​hestring

Hebreo.

campaign_names.​itstring

Italiano.

campaign_names.​jastring

Japonés.

campaign_names.​kostring

Coreano.

campaign_names.​plstring

Polaco.

campaign_names.​ptstring

Portugués.

campaign_names.​rostring

Rumano.

campaign_names.​rustring

Ruso.

campaign_names.​thstring

Tailandés.

campaign_names.​trstring

Turco.

campaign_names.​twstring

Chino (tradicional).

campaign_names.​vistring

Vietnamita.

campaign_redeems_count_for_userinteger

Número máximo de canjes de cupones por usuario en el marco de una campaña. Si se transmite null, el número de canjes es ilimitado.

expiration_datestring(datetime)

Fecha de finalización de la campaña en formato YYYY-MM-DD’T’HH:MM:SS de conformidad con la norma ISO 8601.

project_idintegerrequerido

ID de proyecto.

redeems_countinteger

Número máximo de canjes de cupones. Si se transmite null, el número de canjes es ilimitado.

redeems_count_for_userinteger

Número máximo de canjes de cupones por usuario. Si se transmite null, el número de canjes es ilimitado.

subscription_couponobject

Objeto que contiene parámetros de suscripción en una recompensa.

virtual_currency_amountnumber(float)

Importe en moneda virtual de una recompensa.

virtual_itemsobject

Matriz de parámetros de artículos virtuales de una recompensa.

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/es/api/subscriptions/merchants/{merchant_id}/coupon_promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaign_code": "sample_campaign",
    "campaign_names": {
      "en": "Campaign Name",
      "ru": "Название кампании"
    },
    "campaign_redeems_count_for_user": 1,
    "expiration_date": "2019-12-31",
    "project_id": 12345,
    "redeems_count": 10,
    "redeems_count_for_user": 1,
    "subscription_coupon": {
      "plan_id": 123,
      "product_id": 456,
      "trial_period": 30
    },
    "virtual_currency_amount": 200
  }'

Respuestas

Created.

Cuerpoapplication/json
idinteger
Ejemplo: 9134
Respuesta
application/json
{
  "id": 9134
}

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).

Subscription management

Operaciones