Cómo configurar las notificaciones de límites

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Introducción

Puedes establecer límites relacionados con la monetización, como se describe en Aplica límites de monetización con la política Monetization Limits Check. También puedes configurar notificaciones automáticas que alerten a los desarrolladores, o usuarios de tu organización cuando se acerque o se alcance un límite.

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 tus desarrolladores prepagos, que es su saldo prepagado. Puedes configurar notificaciones automáticas para que se notifique a tus desarrolladores si se acercan a su saldo prepagado o lo alcanzaron.

Caja de herramientas

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

Si usas la API, configura las notificaciones automáticas para los límites editando una plantilla de notificación que proporciona la monetización. Luego, especifica la condición que genera el envío de la notificación que proporciona la plantilla editada.

Configura 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 lo siguiente:
   • El signo mayor o igual que (?) o el signo menor o igual que (?) del menú desplegable
   • Un número entero (es decir, sin decimales) Absoluto (para indicar un valor numérico) o Porcentaje para indicar un valor porcentual Para los límites porcentuales, asegúrate siempre de establecer el límite como >, lo que significa que la notificación se envía cuando el desarrollador alcanza o supera ese nivel porcentual.

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

   

3. En el campo Enviar correo electrónico, selecciona uno o más desarrolladores, o bien 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 una condición de límite de desarrollador de "Cualquiera" o una condición de límite de desarrollador 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 "Desarrollador seleccionado ({developer_id})" en la lista de direcciones de correo electrónico (en la que {developer_id} es la identificación del desarrollador seleccionado). La monetización enviará una notificación solo a ese desarrollador específico.

   Si no seleccionaste una condición de límite de desarrollador de "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 usuarios de tu organización deseas notificar.

   Para agregar direcciones de correo electrónico para los usuarios de tu organización, 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 seleccionar en el campo Enviar correo electrónico "Desarrollador seleccionado (Cualquiera)" o las direcciones de correo electrónico de los usuarios de tu organización (o ambos).Lo que aparece en la plantilla depende de lo siguiente:

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

   Por ejemplo, si se cumplen todas las siguientes condiciones:

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

   La plantilla se ve de la siguiente manera:

   

   Supongamos que el nombre de la empresa del desarrollador es "XYZ company", el límite de volumen de transacciones se establece en 50 para un paquete de API llamado "X Package" y un producto de API llamado "Y Product", y la fecha de vencimiento se establece en el 30 de septiembre de 2013. El mensaje de correo electrónico que se envía se vería 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 para "Desarrollador seleccionado (Cualquiera)", la plantilla aparece de la siguiente manera:

   

   Ambas plantillas resolverán las variables pertinentes, como el nombre del desarrollador (si corresponde), el nombre del paquete (si corresponde) y el nombre del producto (si corresponde). Para editar el mensaje y satisfacer tus requisitos, haz clic en Editar a la izquierda de la plantilla.

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

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

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

   

   Si Detener ejecución no está marcada o el nivel de notificación es mayor o igual que 100%, la plantilla para un desarrollador seleccionado se ve de la siguiente manera:

   

   Nuevamente, si el límite es para "Cualquier" aplicación (o una específica) o "Cualquier" usuario (o uno específico) debes editar la plantilla y, luego, agregar la aplicación ${application.name} o el usuario ${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 API.
   ${application.name}	Es el nombre de la aplicación.
   ${USER}	Es el nombre del usuario.
   ${USAGE}	Es el uso actual (ingresos o cargos totales, o volumen).
   ${PERCENT}	Es el porcentaje del límite alcanzado por el uso actual.
   ${QUOTA_TYPE}	Es el tipo de límite (volumen de transacciones, límite de inversión o exposición a tarifas).
   ${QUOTA_UNIT}	Es la unidad básica para el límite: moneda (para un límite de inversión) o llamadas (para un límite de transacciones).
   ${QUOTA_LIMIT}	Es el importe del límite.
   ${EXPIRY_DATE}	Es la fecha o la hora en que vence el límite o cuando se restablece.

   Por ejemplo, si deseas recibir una notificación cuando un desarrollador alcance un cierto porcentaje del 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 niveles adicionales. Para cada nivel adicional, haz clic en Agregar. Esto agrega un nivel, un correo electrónico de envío y un área 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 estableces 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ímites, así como las notificaciones ad hoc, como 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 Configura notificaciones con plantillas de notificaciones.

Próximos pasos

Obtén información para configurar notificaciones automáticas de modo que puedas alertar a los desarrolladores sobre eventos como productos nuevos, versiones nuevas de los TyC o planes de tarifas nuevos. Consulta Configura notificaciones con plantillas de notificaciones.