Cómo configurar las notificaciones de límites

Estás consultando la documentación de Apigee Edge.
Consulta la documentación de Apigee X. Información

Introducción

Puedes establecer límites relacionados con la monetización como se describe en Aplicar límites de monetización con la política de verificación de límites de monetización. También puedes configurar notificaciones automáticas para alertar a los desarrolladores o usuarios de tu organización cuando se acerque un límite o se alcance.

Puedes configurar notificaciones automáticas para límites personalizados y límites implícitos. Por ejemplo, el sistema establece un límite implícito para los desarrolladores prepagados, que es su saldo prepagado. Puedes configurar notificaciones automáticas para que los desarrolladores reciban una notificación si se acercan a su saldo prepagado o si lo alcanzaron.

Caja de herramientas

Puedes configurar las notificaciones automáticas de límites con la IU de administración o la API de monetización. Si utilizas la IU, configurarás las notificaciones automáticas en la página Notificaciones.

Si usas la API, edita una plantilla de notificación proporcionada por la monetización para configurar las notificaciones automáticas de los límites. Luego, debes especificar la condición que generará el envío de la notificación que proporciona la plantilla editada.

Configura las notificaciones de límites con la IU

  1. Haz clic en Agregar en la sección Notificaciones de la página Agregar límite. Se abrirá la sección Notificación.

  2. Selecciona un nivel para la notificación. Este es un umbral basado en un número absoluto o un porcentaje de la base del límite. Selecciona una de estas opciones:
    • El signo mayor o igual que el signo (?) o el signo menor o igual que el signo (?) en el menú desplegable.
    • Es un número entero (sin decimales). Absoluto (para indicar un valor numérico) o Porcentaje para indicar un valor porcentual. Para los límites de porcentaje, siempre asegúrate de establecer el límite en >, lo que significa que la notificación se envía cuando el desarrollador alcanza o cruza ese nivel de porcentaje.

    Por ejemplo, si estableces un límite de gasto de $100 y configuras la notificación en un 90% o más, la notificación se enviará cuando se alcance o se supere el 90% del límite (USD 90).

  3. En el campo Enviar correo electrónico, selecciona uno o más desarrolladores, o uno o más usuarios de tu organización. Se enviará una notificación a los desarrolladores o usuarios afectados.

    Destinatarios de correo electrónico: Solo puedes enviar notificaciones a los desarrolladores si estableces la condición de límite para desarrolladores como "Cualquiera" o estableces una condición de límite para desarrolladores con un desarrollador específico. Si seleccionaste "Cualquiera", verás "Desarrollador seleccionado (cualquiera)" en la lista de direcciones de correo electrónico. Esto significa que la monetización enviará una notificación a los desarrolladores afectados. Si seleccionaste un desarrollador específico, verás el mensaje "Desarrollador seleccionado ({developer_id})" en la lista de direcciones de correo electrónico (donde {developer_id} es la identificación del desarrollador seleccionado). La monetización solo enviará una notificación a ese desarrollador específico.

    Si no seleccionaste la condición de límite para desarrolladores "Cualquiera" o un desarrollador específico, no verás "Desarrollador seleccionado (cualquiera)" en el campo Enviar correo electrónico. Sin embargo, puedes elegir a cuáles de los usuarios de tu organización quieres notificar.

    Puedes agregar direcciones de correo electrónico para los usuarios de tu organización. Para ello, selecciona Usuarios de la organización en la pestaña Administrador.

    Plantillas de correo electrónico: Verás una plantilla de correo electrónico después de que selecciones la opción "Desarrollador seleccionado (cualquiera)" en el campo Enviar correo electrónico o las direcciones de correo electrónico de los usuarios de tu organización (o ambas).Lo que aparece en la plantilla depende de lo siguiente:

    • El nivel de la notificación.
    • Indica si el límite fue o no una detención de ejecución.
    • Si el correo electrónico era para usuarios de la organización, desarrolladores o ambos

    Por ejemplo, si todo lo siguiente es verdadero:

    • La casilla de verificación Detener ejecución está marcada.
    • El nivel de notificación es del 100% o la misma cantidad que el límite.
    • El correo electrónico es solo para los usuarios de la organización.

    La plantilla tiene el siguiente aspecto:

    Supongamos que el nombre de la empresa del desarrollador es "Empresa XYZ", el límite de volumen de transacciones se establece en 50 para un paquete de API llamado "Paquete X" y un Producto de API llamado "Producto Y", y la fecha de vencimiento es el 30 de septiembre de 2013. El correo electrónico que se envíe se verá de la siguiente manera:

    Developer XYZ company has exceeded their transaction volume limit of 50 transactions for X package, Y product. Their API calls will be blocked till 2013-09-30

    Si el correo electrónico es "Desarrollador seleccionado (Cualquiera)", la plantilla aparece de la siguiente manera:

    Ambas plantillas resolverán las variables relevantes, como el nombre del desarrollador (si corresponde), el nombre del paquete (si corresponde) y el nombre del producto (si corresponde). Puedes editar el mensaje para que cumpla con tus requisitos. Para ello, haz clic en Editar, que se encuentra a la izquierda de la plantilla.

    Si el límite es para "Cualquiera" o una aplicación específica y "Cualquiera" o un usuario específico, también debes agregar variables de las aplicaciones y los usuarios a la plantilla. Para ello, sigue estos pasos:

    • Haz clic en Editar a la izquierda de la plantilla.
    • Agregar ${user.name} user, depending on whether the limit is for application and/or user.

    A continuación, se muestra una plantilla editada para "Cualquiera" o una aplicación específica.

    Si no se marca la opción Detener ejecución o si el nivel de notificación es superior o igual al 100%, la plantilla del desarrollador seleccionado tendrá el siguiente aspecto:

    Una vez más, si el límite es para "Cualquier aplicación" (o una específica) o "Cualquiera" (o un usuario específico), debes editar la plantilla y, luego, agregar la aplicación ${application.name} o un usuario de ${user.name}, según si el límite es para una aplicación, un usuario o ambos.

    Variables de plantilla: Cuando editas el mensaje en una plantilla de correo electrónico, puedes incluir cualquiera de las siguientes variables.

    Variable Descripción
    ${developer.name}

    Es el nombre del desarrollador.
    ${developer.legalName}

    Es el nombre de la empresa del desarrollador.
    ${ratePlan.monetizationPackage.displayName}

    Es el nombre del paquete de la API.
    ${application.name}

    Es el nombre de la aplicación.
    ${USER}

    Es el nombre del usuario.
    ${USAGE}

    Uso actual (ingresos o cargos totales, o volumen).
    ${PERCENT}

    El porcentaje del límite que alcanzó el uso actual.
    ${QUOTA_TYPE}

    Indica el tipo de límite (volumen de transacciones, límite de inversión o exposición de tarifas).
    ${QUOTA_UNIT}

    La unidad básica para el límite: moneda (para el límite de gasto) o llamadas (para el límite de transacción).
    ${QUOTA_LIMIT}

    Es el importe del límite.
    ${EXPIRY_DATE}

    La fecha o la hora en que vence el límite o cuando se restablece.

    Por ejemplo, si quieres recibir una notificación cuando un desarrollador alcance un determinado porcentaje de volumen de transacciones para cualquier paquete en cualquier aplicación, puedes editar la plantilla para que se vea de la siguiente manera:

    ${developer.legalName} has reached a total volume of ${USAGE} on ${ratePlan.monetizationPackage.displayName}. This is ${PERCENT} of the daily/weekly/monthly (state period of limit as appropriate) transaction volume limit of ${QUOTA_LIMIT}.
  4. Agrega notificaciones según sea necesario para los niveles adicionales. Para cada nivel adicional, haz clic en Agregar. Se agregará un área de nivel, de envío de correo electrónico y de plantilla de correo electrónico a la sección Notificaciones de la página. Puedes agregar hasta 6 niveles para tus notificaciones. Por ejemplo, si configuras la notificación como > 70%, 80%, 90%, 100%, se enviará una notificación cuando se alcance cada uno de estos niveles.
  5. Después de agregar todas las notificaciones, haz clic en Guardar (para guardar y publicar las notificaciones en una fecha posterior), Guardar y publicar (para publicar ahora) o Cancelar (para cancelar).

Configura notificaciones de límites con la API

La monetización proporciona un conjunto de plantillas que proporcionan el texto para varios tipos de notificaciones, incluidas las notificaciones de límite y las notificaciones ad hoc, por ejemplo, para alertar a los desarrolladores sobre la disponibilidad de productos nuevos. Puedes adaptar cualquiera de estas plantillas para satisfacer tus necesidades. Para configurar una notificación de límite automática, primero edita una plantilla adecuada. Luego, especifica la condición que genera el envío de la notificación que proporciona la plantilla editada. Para obtener más detalles, consulta Cómo configurar notificaciones con plantillas de notificación.

Próximos pasos

Aprende a configurar notificaciones automáticas para alertar a los desarrolladores sobre eventos como productos nuevos, versiones de Términos y Condiciones o planes de tarifas nuevos. Consulta Configura notificaciones mediante plantillas de notificación.