Estás viendo la documentación de Apigee Edge.
Ve a la
documentación de Apigee X. info
¿Qué son las plantillas de notificaciones?
La monetización proporciona un conjunto de plantillas que definen texto de muestra para varios tipos de notificaciones de eventos. Puedes personalizar cualquiera de estas plantillas para lo siguiente:
- Notificar a todos los desarrolladores sobre eventos, como productos nuevos, versiones nuevas de las Condiciones del Servicio o planes de tarifas nuevos
- Notificar a los desarrolladores afectados sobre eventos, como un plan de tarifas revisado
- Notificar a un proveedor de API sobre eventos relacionados con el desarrollador, como cuando se registra en una cuenta o cuando se registra en un plan de tarifas
- Notificar a todos los administradores de la empresa sobre un evento específico
Como alternativa, puedes crear un webhook que defina un controlador de devolución de llamada HTTP y, luego, configurar la condición que active el webhook, como se describe en Configura notificaciones con webhooks.
Explora la página Notificaciones
Accede a la página Notificaciones, como se describe a continuación.
Edge
Para acceder a la página Notificaciones con la IU de Edge, haz lo siguiente:
- Accede a apigee.com/edge.
- Selecciona Publicar > Monetización > Notificaciones en la barra de navegación izquierda.
Aparecerá la página Notifications.
Como se destaca en la figura, la página Notificaciones te permite hacer lo siguiente:
- Expande y contrae los detalles de las notificaciones
- Cómo editar los detalles de las notificaciones y guardar todos los cambios
- Habilita o inhabilita una notificación
Classic Edge (nube privada)
Para acceder a la página Notificaciones con la IU de Edge clásica, haz lo siguiente:
- Accede a
http://ms-ip:9000, donde ms-ip es la dirección IP o el nombre de DNS del nodo del servidor de administración. Selecciona Administrador > Notificaciones en la barra de navegación superior.
La página Notificaciones te permite hacer lo siguiente:
Cómo editar notificaciones
Para editar una notificación con la IU, haz lo siguiente:
- Accede a la página Notificaciones.
- Haz clic en la
junto a la notificación que deseas editar para expandir sus detalles. - Edita los campos Asunto, Cuerpo y Destinatario (si están disponibles), según sea necesario.
Para obtener información sobre las variables que se pueden especificar en una plantilla de notificación, consulta Cómo usar variables en plantillas de notificaciones.
Consulta las siguientes secciones para obtener más información sobre cómo editar notificaciones en cada categoría:
- Para habilitar una notificación, marca la casilla de verificación junto a ella.
- Repite los pasos 2 a 4 para editar las notificaciones adicionales.
- Haz clic en Guardar para guardar todos los cambios.
Aparecerá un mensaje para confirmar que se guardaron las notificaciones. La operación de guardado puede tardar unos minutos.
Cómo editar notificaciones para notificar a todos los desarrolladores
Las notificaciones de los tipos de eventos que selecciones en la sección Notificar a todos los desarrolladores se enviarán a todos los desarrolladores.
Las notificaciones se programan para que se ejecuten al final del día. Después de que se envían las notificaciones, las casillas de verificación de eventos se borran automáticamente. Debes volver a seleccionarlos para programar notificaciones para los tipos de eventos asociados.
En la siguiente tabla, se muestran las notificaciones según los tipos de eventos en la sección Notificar a todos los desarrolladores. Para obtener más información, consulta Cómo editar notificaciones con la IU.
| Tipo de evento | Activador | Notas |
|---|---|---|
| Paquete nuevo | Hay un nuevo paquete de API disponible |
Agrega el nombre de cada paquete nuevo (y los productos que contiene) al cuerpo de la plantilla de correo electrónico como parte de la actualización. También puedes agregar un vínculo al portal para desarrolladores o a cualquier otro sitio web que proporcione más información sobre la notificación. |
| Producto nuevo | Hay un nuevo producto de API disponible |
Agrega el nombre de cada producto nuevo al cuerpo de la plantilla de correo electrónico como parte de la actualización. También puedes agregar un vínculo al portal para desarrolladores o a cualquier otro sitio web que brinde más información sobre la notificación. |
| Nuevos mercados y cobertura | Los nuevos productos de API están disponibles en mercados geográficos específicos |
Agrega el nombre de cada mercado nuevo y los productos pertinentes al cuerpo de la plantilla de correo electrónico como parte de la actualización. También puedes agregar un vínculo al portal para desarrolladores o a cualquier otro sitio web que proporcione más información sobre la notificación. |
Cómo editar notificaciones para notificar a los desarrolladores afectados
Las notificaciones de los tipos de eventos que selecciones en la sección Notificar a los desarrolladores afectados solo se enviarán a los desarrolladores afectados por esos tipos de eventos. Por ejemplo, si seleccionas el evento Plan de tarifas revisado, se enviará una notificación solo a los desarrolladores que aceptaron el plan de tarifas.
En la siguiente tabla, se enumeran las notificaciones según los tipos de eventos en la sección Notificar a los desarrolladores afectados. Para obtener más información, consulta Cómo editar notificaciones con la IU.
| Tipo de evento | Activador | Notas |
|---|---|---|
| No se aceptaron los Términos y Condiciones o están vencidos | Se publicó un nuevo conjunto de Términos y Condiciones, y el desarrollador aún no los acepta. |
La notificación se envía 30 días, 7 días y 1 día antes de que las nuevas Condiciones del Servicio entren en vigor. |
| Nuevo plan de tarifas | Se publicaron los nuevos planes de tarifas |
Si el plan de tarifas es uno de los siguientes:
|
| Plan de tarifas revisado | Hay una versión más reciente de un plan de tarifas comprado disponible |
Solo se notificará a los desarrolladores que compraron la versión actual. La notificación permite a los desarrolladores revisar la nueva versión y rescindir o cambiar de plan si no desean aceptar las tarifas nuevas. |
| Plan de tarifas vencido | El plan de tarifas venció y no hay un plan de tarifas de seguimiento |
Esta notificación se envía cuando configuras inicialmente el plan de tarifas para que venza, con notificaciones adicionales que se envían 30, 7 y 1 día antes de la fecha de vencimiento. Solo se notificará a los desarrolladores que compraron el plan de tarifas que vencerá. |
| Plan de tarifas renovado | Se renovó la suscripción al plan de tarifas. |
Informa al desarrollador que se le cobrarán las tarifas correspondientes. |
| Se superó el límite de frecuencia | Se superó el límite del plan de tarifas |
Infórmale al desarrollador que se cobrarán las tarifas correspondientes. |
| Plan de tarifas de freemium agotado | Se agotaron los períodos de uso gratuito, medidos por recuento de transacciones o días |
El período de uso gratuito se define en tu plan de tarifas freemium. |
| Se publicó el documento de facturación |
Los documentos de facturación (como las facturas) del desarrollador están disponibles. |
|
| El desarrollador se registra en un nuevo plan de tarifas | El desarrollador se registra en un nuevo plan de tarifas. |
Cómo editar notificaciones para notificar a los proveedores de la API
Las notificaciones de los tipos de eventos que selecciones en la sección Notificar al proveedor de la API se envían al proveedor de la API que especifiques.
En la siguiente tabla, se enumeran las notificaciones según los tipos de eventos en la sección Proveedor de la API de Notify. Para obtener más información, consulta Cómo editar notificaciones con la IU.
| Tipo de evento | Activador |
|---|---|
| Un nuevo desarrollador se registra |
El desarrollador se registró para obtener una cuenta. |
| El desarrollador agrega una app |
El desarrollador creó una aplicación nueva. |
| Registro del desarrollador para un nuevo plan de tarifas |
El desarrollador se registró en un plan de tarifas. |
| El desarrollador cambia los detalles financieros |
El desarrollador cambió los detalles financieros, como el nombre o la dirección de su empresa. |
Habilita o inhabilita una notificación
Para habilitar o inhabilitar una notificación con la IU, haz lo siguiente:
- Accede a la página Notificaciones.
- Para habilitar o inhabilitar una notificación, selecciona o anula la selección, respectivamente, de la casilla de verificación junto a ella.
- Haz clic en Guardar para guardar todos los cambios.
La operación de guardado puede tardar unos minutos. Aparecerá un mensaje para confirmar que se guardaron las notificaciones.
Configura notificaciones con plantillas mediante la API
Configura notificaciones con la API, como se describe en las siguientes secciones.
Administra plantillas de notificaciones con la API
Administra las plantillas de notificación con la API, como se describe en las siguientes secciones:
- Cómo ver todas las plantillas de notificaciones con la API
- Visualiza una plantilla de notificación con la API
- Cómo editar una plantilla de notificación con la API
Cómo ver todas las plantillas de notificaciones con la API
Para enumerar todas las plantillas de notificaciones que proporciona la monetización, envía una solicitud GET a /mint/organizations/{org_name}/notification-email-templates. Por ejemplo:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \ -u email:password
Por ejemplo, la siguiente es una plantilla de evento que notifica a los desarrolladores la disponibilidad de un nuevo producto de API:
{
"createdDate" : 1376975394984,
"htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
"id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
"name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
"orgId" : "myorg",
"source" : "Mail Man Test",
"subject" : "Notification of new product",
"updatedDate" : 1376975394984
}
Cómo ver una plantilla de notificación con la API
Para ver una plantilla de notificación, envía una solicitud GET a /mint/organizations/{org_name}/notification-email-templates/{template_id}, en la que {template_id} es el ID de la plantilla. Por ejemplo:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
-H "Accept:application/json" \
-u email:password
Los elementos de las plantillas que comienzan con $ son variables. Para obtener más información, consulta Cómo usar variables en plantillas de notificaciones. Supongamos que las variables de la notificación se evalúan en los siguientes valores:
${developer.legalName}.XYZ company${developer.name}.DEV1${QUOTA_TYPE}.Transactions${PERCENT}.90%${QUOTA_UNIT}.Calls${QUOTA_LIMIT}.100${ratePlan.monetizationPackage.products.name}.X${EXPIRY_DATE}.2016-09-30
El mensaje de notificación que proporciona la plantilla sería el siguiente:
"Dear XYZ company, DEV1
You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"
Cómo editar una plantilla de notificación con la API
Para editar una plantilla de notificación, envía una solicitud PUT a /nint/organizations/{org_name}/notification-email-templates/{template_id}.
Proporciona el contenido modificado de la plantilla en el cuerpo de la solicitud.
Cuando personalizas el mensaje en una plantilla de notificación, puedes incluir una o más variables. Para obtener más información, consulta Cómo usar variables en plantillas de notificaciones.
Por ejemplo, la siguiente solicitud edita el contenido de una nueva notificación de producto de API:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
-H "Content-Type: application/json" \
-d '{
"id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
"htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
"name" : "NewProductNotification",
"organization": {
"id": "{org_name}"
},
"source" : "Mail Man Test ",
"subject" : "New Product Available: ${Product.name}"
}' \
-u email:password
Administra condiciones y acciones de notificaciones con la API
Administra las condiciones y acciones de las notificaciones con la API, como se describe en las siguientes secciones.
- Cómo crear una condición y una acción de notificación con la API
- Ver una condición y una acción de notificación con la API
- Cómo editar una condición y una acción de notificación con la API
- Cómo borrar una condición y una acción de notificación con la API
Crea una condición y una acción de notificación con la API
Para crear una condición y una acción de notificación que generen una notificación automática, emite una solicitud POST a /mint/organizations/{org_name}/notification-conditions.
Cuando realices la solicitud, especifica en el cuerpo de la solicitud la condición que genera la notificación y las acciones que se deben realizar cuando se alcance la condición (como enviar un correo electrónico de notificación).
Para definir los detalles de la condición de notificación, especifica uno o más valores de atributo. Consulta Propiedades de configuración para las condiciones de las notificaciones para obtener una lista de atributos. En el caso de una notificación de evento, la condición podría activarse cuando se publique un producto nuevo.
Cuando definas actions, consulta la plantilla de notificación aplicable. Consulta Propiedades de configuración para acciones de notificación para obtener una lista de acciones.
Por ejemplo, la siguiente solicitud especifica que, cuando el atributo sea NEW_PRODUCT y el valor del atributo PUBLISHED sea true, se debe enviar la notificación en la plantilla con el ID 01191bf9-5fdd-45bf-8130-3f024694e63 (este es el DEFAULT_NEW_PRODUCT_TEMPLATE).
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
-H "Content-Type:application/json"
-d '{
"notificationCondition": [
{
"attribute": "NEW_PRODUCT"
},
{
"attribute": "PUBLISHED",
"value": "true"
}
],
"actions": [{
"actionAttribute": "DEV_ID",
"value": "ANY",
"templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
}]
}' \
-u email:password
Ver una condición y una acción de notificación con la API
Para ver una condición y una acción de notificación, envía una solicitud GET a organizations/{org_name}/notification-conditions/{condition_Id}, en la que {condition_Id} es el ID de la condición. El ID se muestra cuando creas la condición de notificación. Por ejemplo:
curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
-H "Accept:application/json" \
-u email:password
A continuación, se proporciona un ejemplo de la respuesta.
{
"actions" : [ {
"actionAttribute" : "DEV_ID",
"id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
"templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
"value" : "ANY"
}, {
"actionAttribute" : "ORG_EMAIL",
"id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
"templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
"value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
} ],
"notificationCondition" : [ {
"attribute" : "Balance",
"id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
"organization" : {
...
},
"value" : "< 0"
} ]
}
Cómo editar una condición y una acción de notificación con la API
Para editar una condición y una acción de notificación, envía una solicitud POST a organizations/{org_name}/notification-conditions/{condition_Id}, en la que {condition_Id} es el ID de la condición. El ID se muestra cuando creas la condición de notificación. Cuando envíes la solicitud, especifica en el cuerpo de la solicitud los cambios que
deseas realizar en la condición o acción de la notificación.
Por ejemplo:
$ curl -H "Content-Type:application/json" -X POST -d \
' {
"notificationCondition": [
{
"attribute": "NEW_PRODUCT"
},
{
"attribute": "PUBLISHED",
"value": "true"
}
],
"actions": [{
"actionAttribute": "DEV_ID",
"value": "ANY",
"templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
-u email:password
Cómo borrar una condición y una acción de notificación con la API
Para borrar una condición de notificación, envía una solicitud DELETE a organizations/{org_name}notification-conditions/{condition_Id}. Por ejemplo:
curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
-H "Accept:application/json" \
-u email:password
Propiedades de configuración para las condiciones de las notificaciones
Las siguientes propiedades de configuración para las condiciones de notificaciones están disponibles cuando se usa la API.
| Nombre | Descripción | Predeterminado | ¿Obligatorio? |
|---|---|---|---|
attribute |
Detalles de la condición de notificación. Puedes especificar uno o más atributos para definir mejor la condición de notificación. El valor puede ser uno o más de los siguientes:
|
N/A | Sí |
value |
Valor del atributo. |
N/A | No |
associatedCondition |
Referencia a una condición asociada. |
N/A | No |
Propiedades de configuración para acciones de notificaciones
Las siguientes propiedades de configuración están disponibles para las acciones de notificación cuando se usa la API.
| Nombre | Descripción | Predeterminado | ¿Obligatorio? |
|---|---|---|---|
actionAttribute |
Es el método que se usa para identificar al destinatario de la notificación. El valor puede ser uno o más de los siguientes:
|
N/A | Sí |
value |
Es el valor del atributo action. Si Si Si |
N/A | Sí |
templateID |
Es el ID de la plantilla de notificación. Nota: Esta opción no es válida si |
N/A | Sí |
postURL |
Controlador de devoluciones de llamada para el webhook. Nota: Esta opción es obligatoria si |
N/A | Sí |
Usa variables en plantillas de notificaciones
Cuando editas el mensaje en una plantilla de notificación, puedes incluir una o más variables, con el lenguaje de expresiones de Spring (SpEL), para representar los valores que se muestran en el objeto Transaction.
En la siguiente tabla, se resumen las variables de plantilla de notificación más usadas.
| Variable | Descripción |
|---|---|
${application.name} |
Es el nombre de una aplicación. |
${application.products.name} |
Es el nombre de un producto incluido en una aplicación. |
${BALANCE} |
Es el saldo de una cuota determinada. |
${developer.legalName} |
Es el nombre de la empresa del desarrollador. |
${developer.name} |
Es el nombre de un desarrollador. |
${EXPIRY_DATE} |
Es la fecha o la hora en la que vence o se restablece un límite. |
${LONG_PERCENT} |
El porcentaje de un límite alcanzado por el uso actual, sin el símbolo %. Por ejemplo, 50 |
${PERCENT} |
Porcentaje de un límite alcanzado por el uso actual, con el símbolo %. Por ejemplo, 50%. |
${products.displayName} |
Es el nombre visible definido para un producto. |
${QUOTA_TYPE} |
Tipo de límite (volumen de transacciones, límite de inversión o exposición a tarifas). |
${QUOTA_UNIT} |
Es la unidad básica de un límite: moneda (para un límite de inversión) o llamadas (para un límite de transacción). |
${QUOTA_LIMIT} |
Es el importe de un límite. |
${ratePlan.displayName} |
Es el nombre visible definido para un plan de tarifas. |
${ratePlan.endDate} |
Fecha en la que un proveedor de API finalizó un plan de tarifas. |
${ratePlan.monetizationPackage.displayName} |
Es el nombre de un paquete de API. |
${ratePlan.monetizationPackage.name} |
Es el nombre de un paquete de monetización. |
${ratePlan.monetizationPackage.products.displayName} |
Es el nombre visible definido para un producto de API. |
${ratePlan.monetizationPackage.products.name} |
Es el nombre de un producto incluido en un paquete de monetización. |
${ratePlan.startDate} |
Es la fecha en la que se creó un plan de tarifas. |
${USAGE} |
Uso actual (ingresos, cargos o volumen totales) |
${USER} |
Es el nombre de un usuario. |
Cómo personalizar tu dirección de correo electrónico de respuesta
Para la monetización, se configura una dirección noreply@apigee.com predeterminada para usar en las notificaciones por correo electrónico que se envían a las empresas y a los desarrolladores. Comunícate con la asistencia de Apigee si quieres configurar un nombre y una dirección de respuesta personalizados para tu organización.