Objetivo

Activar o desactivar automáticamente el acceso de usuarios en una plataforma externa con base en el ciclo de vida de la suscripción en EVO.

Endpoint

Este caso de uso depende principalmente de eventos vía webhook y de consultas complementarias a los endpoints de ventas, matrículas y cuentas por cobrar de la API.

Requisitos

webhooks de venta y recurrencia: Deben estar configurados para notificar siempre que ocurra una nueva venta o renovación.

webhooks de cancelación: Deben estar configurados para notificar cancelaciones inmediatas o programadas de matrícula.

webhook de liquidación de saldo vencido: Debe estar configurado para notificar cuando una deuda vencida sea regularizada.

identificador de la venta: Necesario para consultar los datos completos de la venta cuando el evento devuelva idSale.

identificador de la matrícula: Necesario para consultar los datos de la matrícula cuando el evento devuelva idMemberMembership.

correo electrónico del usuario: Necesario para realizar el vínculo entre el usuario de la plataforma externa y el registro de la plataforma de gestión.

Paso a Paso

1. Configure los webhooks necesarios

Registre los eventos de venta y renovación para capturar nuevas activaciones de acceso.

Registre también los eventos de cancelación y regularización financiera para reflejar cambios de estado de la suscripción.

Eventos recomendados:

NewSale

RecurrentSale

CancelMembership

ScheduleCancelMembership

ClearedDebt

2. Trate los eventos de venta y renovación

Cuando ocurra una nueva venta o renovación, el sistema externo recibirá un webhook con el identificador de la venta.

Almacene el idSale recibido para su uso en la consulta posterior.

3. Consulte los detalles de la venta

Utilice el idSale recibido en el webhook para consultar los detalles completos de la venta.

En la respuesta de la venta, localice el objeto del miembro y obtenga los datos necesarios para la integración.

Datos importantes para el flujo:

idMember

email

datos de la venta

datos de las cuentas por cobrar asociadas

4. Identifique al usuario en la plataforma externa

Utilice el correo electrónico devuelto en el objeto del miembro para localizar al usuario correspondiente en la plataforma externa.

Si el usuario aún no existe, siga la estrategia definida por su sistema para creación, invitación o activación.

5. Active el acceso

Cuando la venta o renovación sea válida, active el acceso del usuario en la plataforma externa.

Si es necesario, envíe una comunicación de activación, invitación o enlace de primer acceso.

6. Trate los eventos de cancelación

Cuando ocurra una cancelación de matrícula, inmediata o programada, el sistema recibirá un webhook que contiene idMemberMembership.

Utilice ese identificador para consultar los datos de la matrícula.

Con base en el estado y en las reglas de su sistema, desactive el acceso inmediatamente o programe la desactivación para la fecha correcta.

7. Trate la liquidación de saldo vencido

Cuando ocurra el evento ClearedDebt, consulte nuevamente la venta con base en el idSale devuelto.

Verifique las cuentas por cobrar asociadas a la venta y confirme el estado financiero del alumno.

Si la regularización restablece el derecho de uso, reactive el acceso en la plataforma externa.

8. Valide el estado financiero antes de activar o mantener el acceso

Al consultar la venta, utilice el objeto de receivables para evaluar la situación del pago.

Considere los posibles estados financieros:

1 = Abierto

2 = Recibido

3 = Cancelado

4 = Atrasado

Importante:
La regla de activación, bloqueo o reactivación debe considerar la política comercial y financiera adoptada por la integración.

Ejemplo de Flujo

Un usuario contrata o renueva un plan en la plataforma de gestión.

Un webhook de venta o renovación se dispara hacia el sistema externo.

El sistema externo recibe el idSale.

El sistema consulta los detalles de la venta.

El sistema obtiene el idMember y el correo electrónico del usuario.

El sistema realiza el vínculo con el usuario en la plataforma externa.

El sistema activa el acceso y envía una comunicación de activación, si aplica.

Si en el futuro ocurre una cancelación o atraso relevante, nuevos eventos actualizan ese acceso.

Preguntas Frecuentes

1. ¿Qué eventos deben registrarse en el webhook?

Para el flujo completo, se recomienda utilizar eventos de:

venta realizada

renovación recurrente

cancelación de matrícula

programación de cancelación

liquidación de saldo vencido

2. ¿Cómo obtener los datos del usuario después de recibir el webhook?

Cuando el webhook devuelva idSale, consulte los detalles de la venta.

Cuando devuelva idMemberMembership, consulte los detalles de la matrícula.

3. ¿Cómo localizar al usuario en la plataforma externa?

El identificador más común para la vinculación es el correo electrónico devuelto en los datos del miembro.

4. ¿El acceso debe desactivarse en cualquier cancelación?

Esto depende de la regla de negocio de la integración.

En cancelaciones programadas, puede ser necesario mantener el acceso hasta la fecha efectiva de finalización.

5. ¿Qué hacer cuando un pago atrasado sea regularizado?

Utilice el evento de liquidación del saldo vencido para revisar la situación financiera y, si aplica, reactivar el acceso.

Resultado Esperado

Si todas las etapas se siguen correctamente:

nuevas suscripciones y renovaciones pasan a activar el acceso automáticamente;

las cancelaciones pasan a desactivar o programar la desactivación del acceso;

las regularizaciones financieras permiten reevaluar y restablecer el acceso cuando aplique.

Consejos Finales

Siempre consulte los datos completos de la venta o de la matrícula después del webhook.

No tome decisiones solo con base en el evento recibido; use los endpoints complementarios para confirmar el estado actual.

Centralice la lógica de activación y desactivación en una regla única en el sistema externo.

Trate eventos duplicados de webhook con idempotencia.

Registre logs de procesamiento para auditoría y reprocesamiento.

Soporte

Si hay dudas sobre los eventos disponibles, payloads de webhook o endpoints de consulta, consulte la documentación.

Control de acceso de usuario mediante servicio externo

Objetivo#

Endpoint#

Requisitos#

Paso a Paso#

1. Configure los webhooks necesarios#

2. Trate los eventos de venta y renovación#

3. Consulte los detalles de la venta#

4. Identifique al usuario en la plataforma externa#

5. Active el acceso#

6. Trate los eventos de cancelación#

7. Trate la liquidación de saldo vencido#

8. Valide el estado financiero antes de activar o mantener el acceso#

Ejemplo de Flujo#

Preguntas Frecuentes#

1. ¿Qué eventos deben registrarse en el webhook?#

2. ¿Cómo obtener los datos del usuario después de recibir el webhook?#

3. ¿Cómo localizar al usuario en la plataforma externa?#

4. ¿El acceso debe desactivarse en cualquier cancelación?#

5. ¿Qué hacer cuando un pago atrasado sea regularizado?#

Resultado Esperado#

Consejos Finales#

Soporte#