Saltar al contenido principal

Suscribirse al contenido

En este ejemplo, demostramos cómo gestionar el acceso basado en suscripciones al contenido utilizando la API de OneEntry. Verificamos si un usuario tiene una suscripción activa y, en función de eso, le otorgamos acceso al contenido premium o le solicitamos que se suscriba.

✅ Propósito del escenario:

  • Solo los usuarios con una suscripción tienen acceso al contenido.
  • La verificación se basa en Orders, User.
  • Aquellos que no están autorizados o no han realizado una compra recibirán una oferta para suscribirse.

✅ Lo que necesitas:

  • Un PROJECT_URL y APP_TOKEN válidos para la autenticación con la API de OneEntry.
  • Formulario con marcador "subscriptions", atributos "expired_date" y "subscription_time" y tipo "Order form".
  • Usuario registrado.

📌 Importante:

  • Estos ejemplos no incluyen manejo de errores.
  • Puedes gestionar errores utilizando un bloque try-catch o empleando una construcción como await Promise.catch((error) => error).

📚 Ver en la documentación:

📦 Referencia del SDK:

Pruébalo en vivo​

Ejecuta este método de forma interactiva en el sandbox del JS SDK — conecta tu Project URL y App Token en la primera visita, luego abre:

  • Suscribirse al contenido — En este ejemplo, demostramos cómo gestionar el acceso basado en suscripciones al contenido utilizando la API de OneEntry. Verificamos si un usuario tiene una suscripción activa y, en función de eso, le otorgamos acceso al contenido premium o le solicitamos que se suscriba.

Escenario​

1. Importar defineOneEntry desde el SDK y definir PROJECT_URL y APP_TOKEN​

Ejemplo:

import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

2. Creando un cliente API con defineOneEntry()​

Ejemplo:

const { Users, Orders, Pages, Payments, AuthProvider, Forms } = defineOneEntry(
  PROJECT_URL,
  {
    token: APP_TOKEN,
  },
);

3. Obtener formulario​

Ejemplo:

const form = await Forms.getFormByMarker('subscription');
console.log(form);
// expired_date - Date
// subscription_time - list
Resultado:
{
  "id": 6,
  "attributeSetId": 8,
  "type": "order",
  "localizeInfos": {
    "title": "Subscription",
    "titleForSite": "Subscription",
    "successMessage": "Message about successful data processing",
    "unsuccessMessage": "Message about unsuccessful data processing",
    "urlAddress": "",
    "database": "0",
    "script": "0"
  },
  "version": 21,
  "position": 1,
  "identifier": "subscription",
  "processingType": "script",
  "templateId": null,
  "attributes": [
    {
      "type": "date",
      "marker": "expired_date",
      "position": 2,
      "settings": {},
      "isVisible": true,
      "listTitles": [],
      "validators": {},
      "initialValue": null,
      "localizeInfos": {
        "title": "Expired date"
      },
      "additionalFields": {}
    },
    {
      "type": "list",
      "marker": "subscription_time",
      "position": 5,
      "settings": {},
      "isVisible": true,
      "listTitles": [
        {
          "title": "1 month",
          "value": "1",
          "extended": {
            "type": "real",
            "value": "100"
          },
          "position": 1
        },
        {
          "title": "6 months",
          "value": "6",
          "extended": {
            "type": "real",
            "value": "500"
          },
          "position": 2
        },
        {
          "title": "1 year",
          "value": "12",
          "extended": {
            "type": "real",
            "value": "999"
          },
          "position": 3
        }
      ],
      "validators": {},
      "initialValue": null,
      "localizeInfos": {
        "title": "Subscription time"
      },
      "additionalFields": {}
    }
  ],
  "total": "1",
  "moduleFormConfigs": []
}

4. Preparando datos para la autorización del usuario​

Ejemplo:

const authData = [
  { marker: 'email_reg', value: 'your-email' },
  { marker: 'password_reg', value: 'your-password' },
];
Resultado:
[
  {
    "marker": "email_reg",
    "value": "kvasssukr.net@gmail.com"
  },
  {
    "marker": "password_reg",
    "value": "123456"
  }
]

5. Autorización y obtención de datos del usuario con AuthProvider.auth()​

Ejemplo:

const authResponse = await AuthProvider.auth('email', { authData });
console.log(authResponse);

const user = await Users.getUser();
console.log(user);
Resultado:
{
  "id": 39,
  "total": "1",
  "identifier": "kvasssukr.net@gmail.com",
  "authProviderIdentifier": "email",
  "formData": [
    {
      "marker": "name_reg",
      "type": "string",
      "value": "Ivan"
    },
    {
      "marker": "phone_reg",
      "type": "string",
      "value": "+10000000001"
    },
    {
      "marker": "email_notification_reg",
      "type": "string",
      "value": "test@example.com"
    }
  ],
  "formIdentifier": "reg",
  "groups": [
    1
  ],
  "state": {},
  "rating": {},
  "moduleFormConfigs": []
}

6. Obtenemos una lista de órdenes del usuario con Orders.getAllOrdersByMarker()​

Ejemplo:

const orders = await Orders.getAllOrdersByMarker('subscriptions');

if ('statusCode' in orders) {
  throw new Error(orders.message);
}
Resultado:
{
  "items": [
    {
      "id": 119,
      "storageId": 2,
      "createdDate": "2026-06-06T11:50:12.995Z",
      "statusIdentifier": "active",
      "statusLocalizeInfos": {
        "title": "Active"
      },
      "formIdentifier": "subscription",
      "formData": [
        {
          "type": "date",
          "marker": "expired_date",
          "value": {
            "fullDate": "2026-05-07T00:00:00.000Z",
            "formattedValue": "07-05-2026 00:00",
            "formatString": "DD-MM-YYYY HH:mm"
          }
        },
        {
          "type": "list",
          "marker": "subscription_time",
          "value": [
            "1"
          ]
        }
      ],
      "attributeSetIdentifier": "subscriptions",
      "paymentStrategy": "once",
      "totalSum": "400",
      "totalSumRaw": "400",
      "currency": "USD",
      "paymentAccountIdentifier": "cash",
      "paymentAccountLocalizeInfos": {
        "title": "Cash"
      },
      "products": [
        {
          "id": 15,
          "title": "Orange ball",
          "sku": null,
          "previewImage": "[]",
          "price": 400,
          "quantity": 1,
          "isGift": false
        }
      ],
      "paymentUrl": null,
      "discountConfig": {
        "orderDiscounts": [],
        "productDiscounts": [],
        "coupon": null,
        "settings": {
          "allowStacking": false,
          "maxDiscountValue": null,
          "allowGiftStacking": false,
          "maxBonusPaymentPercent": null,
          "minBonusAmount": null,
          "minOrderAmountForBonus": null,
          "giftRefundPolicy": "KEEP_GIFT"
        },
        "additionalDiscountsMarkers": [],
        "totalRaw": 400,
        "totalSumWithDiscount": 400,
        "excludedGiftProductIds": [],
        "bonus": {
          "availableBalance": 0,
          "maxBonusDiscount": 0,
          "minBonusAmount": null,
          "minOrderAmountForBonus": null,
          "bonusApplied": 0
        },
        "bonusApplied": 0,
        "totalDue": 400
      },
      "isPartial": false,
      "isCompleted": false
    }
  ],
  "total": 1
}

7. Verificando si hay una suscripción activa​

Ejemplo:

const now = new Date();
const hasActiveSubscription = orders.items?.some(
  (order: any) =>
    new Date(
      order.formData.find(
        (d: { marker: string }) => d.marker === 'expired_date',
      ).value.fullDate,
    ) > now,
);

8. Si la suscripción está activa, proporcionamos acceso; de lo contrario, creamos un pedido y generamos el pago​

Ejemplo:

let content = null;
if (hasActiveSubscription) {
  // ✅ Subscription active → show content
  content = await Pages.getPageByUrl('premium_page');
  console.log('🎉 Access is open:', content);
} else {
  // ❌ No subscription → create an order and generate payment
  const body = {
    formIdentifier: 'subscription',
    paymentAccountIdentifier: 'cash',
    formData: [
      {
        type: 'date',
        marker: 'expired_date',
        value: {
          fullDate: '2026-05-07T00:00:00.000Z',
          formattedValue: '07-05-2026 00:00',
          formatString: 'DD-MM-YYYY HH:mm',
        },
      },
      {
        // A `list` field takes an array of the selected option values
        // (plain strings), not option objects. '1' = the "1 month" option.
        type: 'list',
        marker: 'subscription_time',
        value: ['1'],
      },
    ],
    products: [
      {
        productId: 15,
        quantity: 1,
      },
    ],
  };
  const order = await Orders.createOrder('subscriptions', body);

  if ('statusCode' in order) {
    throw new Error(order.message);
  }

  const payment = await Payments.createSession(order.id, 'session', false);
  console.log('💸 Proceed to pay for your subscription:', payment);
}

Ejemplo final​

// 1. Import defineOneEntry from SDK and define PROJECT_URL and APP_TOKEN
import { defineOneEntry } from 'oneentry';

const PROJECT_URL = 'your-project-url';
const APP_TOKEN = 'your-app-token';

// 2. Creating an API client with [defineOneEntry()](/docs/index/#Installation)
const { Users, Orders, Pages, Payments, AuthProvider, Forms } = defineOneEntry(
  PROJECT_URL,
  {
    token: APP_TOKEN,
  },
);

// 3. Get form
const form = await Forms.getFormByMarker('subscription');
console.log(form);
// expired_date - Date
// subscription_time - list

// 4. Preparing data for user authorization
const authData = [
  { marker: 'email_reg', value: 'your-email' },
  { marker: 'password_reg', value: 'your-password' },
];

// 5. Authorization and obtaining user data with [AuthProvider.auth()](/docs/auth-provider/auth)
const authResponse = await AuthProvider.auth('email', { authData });
console.log(authResponse);

const user = await Users.getUser();
console.log(user);

// 6. We get a list of user orders with [Orders.getAllOrdersByMarker()](/docs/orders/getAllOrdersByMarker)
const orders = await Orders.getAllOrdersByMarker('subscriptions');

if ('statusCode' in orders) {
  throw new Error(orders.message);
}

// 7. Checking for an active subscription
const now = new Date();
const hasActiveSubscription = orders.items?.some(
  (order: any) =>
    new Date(
      order.formData.find(
        (d: { marker: string }) => d.marker === 'expired_date',
      ).value.fullDate,
    ) > now,
);

// 8. If the subscription is active, we provide access, otherwise we create an order and generate payment
let content = null;
if (hasActiveSubscription) {
  // ✅ Subscription active → show content
  content = await Pages.getPageByUrl('premium_page');
  console.log('🎉 Access is open:', content);
} else {
  // ❌ No subscription → create an order and generate payment
  const body = {
    formIdentifier: 'subscription',
    paymentAccountIdentifier: 'cash',
    formData: [
      {
        type: 'date',
        marker: 'expired_date',
        value: {
          fullDate: '2026-05-07T00:00:00.000Z',
          formattedValue: '07-05-2026 00:00',
          formatString: 'DD-MM-YYYY HH:mm',
        },
      },
      {
        // A `list` field takes an array of the selected option values
        // (plain strings), not option objects. '1' = the "1 month" option.
        type: 'list',
        marker: 'subscription_time',
        value: ['1'],
      },
    ],
    products: [
      {
        productId: 15,
        quantity: 1,
      },
    ],
  };
  const order = await Orders.createOrder('subscriptions', body);

  if ('statusCode' in order) {
    throw new Error(order.message);
  }

  const payment = await Payments.createSession(order.id, 'session', false);
  console.log('💸 Proceed to pay for your subscription:', payment);
}