Cómo configurar notificaciones mediante plantillas de notificaciones

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

¿Qué son las plantillas de notificación?

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:

  • Notifica a todos los desarrolladores sobre eventos, como productos nuevos, versiones de los Términos y Condiciones o planes de tarifas nuevos.
  • Notifica a los desarrolladores afectados sobre eventos como un plan de tarifas revisado.
  • Notifica a un proveedor de APIs sobre eventos relacionados con el desarrollador, como cuando un desarrollador se registra en una cuenta o en un plan de tarifas.
  • Notificar a todos los administradores de la empresa acerca de 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 activa el webhook, como se describe en Configura notificaciones mediante webhooks.

Cómo explorar la página Notificaciones

Accede a la página Notificaciones, como se describe a continuación.

Conexión de integración

Para acceder a la página Notificaciones con la IU de Edge, haz lo siguiente:

  1. Accede a apigee.com/edge.
  2. Selecciona Publicar > Monetización > Notificaciones en la barra de navegación izquierda.

Se mostrará la página Notificaciones.

Como se destaca en la figura, la página Notificaciones te permite hacer lo siguiente:

Versión clásica de Edge (nube privada)

Para acceder a la página Notificaciones con la IU clásica de Edge, sigue estos pasos:

  1. 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.
  2. Selecciona Administrador > Notificaciones en la barra de navegación superior.

La página Notificaciones te permite:

Edición de notificaciones

Para editar una notificación con la IU, haz lo siguiente:

  1. Accede a la página Notificaciones.
  2. Haz clic en la junto a la notificación que quieres editar para expandir sus detalles.
  3. 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 dentro de una plantilla de notificación, consulta Usa variables en plantillas de notificación.

    Consulta las siguientes secciones para obtener más información sobre la edición de notificaciones en cada categoría:

  4. Para habilitar una notificación, marca la casilla de verificación junto a ella.
  5. Repite los pasos 2 a 4 para editar notificaciones adicionales.
  6. Haz clic en Guardar para guardar todos los cambios.

Aparecerá un mensaje para confirmar que se guardaron las notificaciones. El guardado puede tardar unos minutos.

Edición de notificaciones para notificar a todos los desarrolladores

Las notificaciones para los tipos de eventos que seleccionas en la sección Notificar a todos los desarrolladores se envían a todos los desarrolladores.

Las notificaciones están programadas para ejecutarse al final del día. Una vez que se envían las notificaciones, las casillas de verificación de los eventos se borran automáticamente. Debes seleccionarlos nuevamente si quieres programar notificaciones para los tipos de eventos asociados.

La siguiente tabla muestra las notificaciones según los tipos de eventos de la sección Notificar a todos los desarrolladores. Para obtener más información, consulta Edita notificaciones con la IU.

Tipo de evento Activador Notas
Nuevo paquete Hay un nuevo paquete de API disponible

Agrega el nombre de cada paquete nuevo (y los productos contenidos en cada paquete) al cuerpo de la plantilla de correo electrónico como parte de tu 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 tu 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.

Mercados nuevos/cobertura Hay nuevos productos de API 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 tu 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.

Edición de notificaciones para notificar a los desarrolladores afectados

Las notificaciones para los tipos de eventos que seleccionas en la sección Notificar a los desarrolladores afectados se envían solo 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 de la sección Notificar a los desarrolladores afectados. Para obtener más información, consulta Edita notificaciones con la IU.

Tipo de evento Activador Notas
Términos y Condiciones no aceptados o vencidos Se publicó un nuevo conjunto de Términos y Condiciones, y el desarrollador todavía no los aceptó.

La notificación se envía 30, 7 y 1 día antes de que entren en vigencia los nuevos Términos y Condiciones.

Nuevo plan de tarifas Se publicaron los nuevos planes de tarifas

Sigue estos pasos según el plan de tarifas:

  • Standard, todos los desarrolladores reciben una notificación.
  • Plan de tarifas de la categoría de desarrollador (solo se notifica a los desarrolladores de esa categoría).
  • Plan de tarifas del desarrollador; solo se notificará al desarrollador específico.
Plan de tarifas revisado Hay disponible una versión más reciente del plan de tarifas que compraste

Solo se notificará a los desarrolladores que compraron la versión actual. La notificación permite a los desarrolladores revisar la versión nueva y cancelar o cambiar de plan si no desean aceptar las nuevas tarifas.

Plan de tarifas vencido El plan de tarifas venció sin un plan de tarifas de seguimiento

Esta notificación se envía cuando estableces inicialmente el vencimiento del plan de tarifas, y se envían notificaciones adicionales 30, 7 y 1 día antes de la fecha de vencimiento. Solo se notificará a los desarrolladores que hayan comprado el plan de tarifas vencido.

Plan de tarifas renovadas Se renovó la suscripción al plan de tarifas.

Informa al desarrollador que se cobrarán las tarifas aplicables.

Se superó el límite de frecuencia Se superó el límite del plan de tarifas

Informa al desarrollador que se cobrarán las tarifas aplicables.

Plan de tarifas freemium agotado Se agotaron los períodos de uso gratuito, medidos por la cantidad de transacciones o por días

El período de uso gratuito se define según tu plan de tarifas freemium.

Documento de facturación publicado

Hay documentos de facturación (como facturas) disponibles para el desarrollador.

El desarrollador se registra en el nuevo Plan de tarifas El desarrollador se registra en un nuevo plan de tarifas.

Edición de notificaciones para notificar a los proveedores de API

Las notificaciones para los tipos de eventos que seleccionas en la sección Notify API Provider se envían al proveedor de API que especifiques.

La siguiente tabla incluye las notificaciones según los tipos de eventos de la sección Notify API Provider. Para obtener más información, consulta Edita notificaciones con la IU.

Tipo de evento Activador
Registros de desarrolladores nuevos

El desarrollador se registró con una cuenta.

El desarrollador agrega una app

El desarrollador creó una aplicación nueva.

Registrarse para el nuevo plan de tarifas

El desarrollador se registró en un plan de tarifas.

Detalles financieros de cambios del desarrollador

El desarrollador cambió los detalles financieros, como el nombre o la dirección de la empresa.

Habilitar o inhabilitar una notificación

Para habilitar o inhabilitar una notificación con la IU, haz lo siguiente:

  1. Accede a la página Notificaciones.
  2. Habilita o inhabilita una notificación marcando o anulando la selección, respectivamente, de la casilla de verificación que se encuentra junto a ella.
  3. Haz clic en Guardar para guardar todos los cambios.

El guardado puede tardar unos minutos. Aparecerá un mensaje para confirmar que se guardaron las notificaciones.

Configura notificaciones mediante plantillas mediante la API

Configura las 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:

Visualiza 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 sobre 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 Usa variables en plantillas de notificación. Supongamos que las variables en 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 proporcionado por 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"

Edita 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 notificación.

Por ejemplo, la siguiente solicitud edita el contenido de una notificación de producto de API nuevo:

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 las condiciones y acciones de las 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

Crea una condición y acción de notificación que generen una notificación automática mediante la emisión de 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 da como resultado la notificación y las acciones que se deben realizar cuando se cumpla la condición (como enviar una notificación por correo electrónico).

Para definir los detalles de la condición de notificación, debes especificar uno o más valores de atributos. Consulta Propiedades de configuración para las condiciones de notificación a fin de obtener una lista de atributos. En el caso de una notificación de evento, la condición se puede activar cuando se publica un producto nuevo.

Cuando definas el actions, haz referencia a la plantilla de notificación aplicable. Para ver una lista de acciones, consulta Propiedades de configuración de las acciones de notificación.

Por ejemplo, la siguiente solicitud especifica que, cuando el atributo es NEW_PRODUCT y el valor del atributo PUBLISHED es true, se debe enviar la notificación en la plantilla con el ID 01191bf9-5fdd-45bf-8130-3f024694e63 (esta es la 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

Visualiza una condición y acción de notificación mediante la API

Puedes ver una condición y acción de notificación mediante 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 la 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"
    } ]
    }

Edita una condición y acción de notificación con la API

Para editar una condición y acción de la 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 la notificación. Cuando envíes la solicitud, especifica en el cuerpo de la solicitud los cambios que deseas realizar en la acción o condició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 acción de notificación mediante la API

Envía una solicitud DELETE a organizations/{org_name}notification-conditions/{condition_Id} para borrar una condición de notificación. 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 notificación

Las siguientes propiedades de configuración para las condiciones de notificación están disponibles cuando se usa la API.

Nombre Descripción Predeterminada ¿Obligatorio?
attribute

Detalles de la condición de la notificación. Puedes especificar uno o más atributos para definir mejor la condición de la notificación.

El valor puede ser uno o más de los siguientes:

  • ADD_RATEPLAN
  • ADHOC_NOTIFY_DEVELOPERS
  • BILLING_DOCS_PUBLISHED
  • COMPANY_ACCEPTS_INVITATION
  • COMPANY_CANCELS_INVITATION
  • COMPANY_DECLINES_INVITATION
  • COMPANY_INVITES_DEVELOPER
  • CREATE_APPLICATION
  • CREATE_DEVELOPER
  • DATE
  • DEVELOPER_ACCEPTS_INVITATION
  • DEVELOPER_CANCELS_INVITATION
  • DEVELOPER_DECLINES_INVITATION
  • DEVELOPER_INVITES_COMPANY
  • EXPIRING_TNC
  • FeeExposure
  • FREEMIUM_USED_UP
  • NEW_PACKAGE
  • NEW_PRODUCT
  • PUBLISHED
  • RATEPLAN
  • RATEPLAN_ACCEPTED
  • RATEPLAN_ENDED
  • RATEPLAN_EXPIRED
  • RATEPLAN_RENEWED
  • RATEPLAN_REVISION
  • Transactions
  • UPDATE_DEVELOPER
  • UsageTarget (válido solo para configurar webhooks)
No disponible
value

Valor del atributo.

No disponible No
associatedCondition

Es la referencia a una condición asociada.

No disponible No

Propiedades de configuración para acciones de notificación

Las siguientes propiedades de configuración están disponibles para las acciones de notificación cuando se usa la API.

Nombre Descripción Predeterminada ¿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:

  • ORG_EMAIL. El destinatario de la notificación se identifica por la dirección de correo electrónico.
  • DEV_ID. El destinatario de la notificación se identifica por el ID de desarrollador (dirección de correo electrónico).
  • COMPANY_ADMINS. Se envía una notificación a todos los administradores de la empresa, independientemente del valor establecido. Ten en cuenta que los administradores de la empresa son diferentes de los administradores de la organización.
  • WEBHOOK. La información del destinatario de la notificación se envía al controlador de devolución de llamada del webhook. Consulta Configura notificaciones mediante webhooks.
No disponible
value

Valor del atributo de acción.

Si actionAttribute está configurado como ORG_EMAIL o DEV_ID, un valor de ANY envía la notificación a cualquier destinatario aplicable, por ejemplo, cualquier dirección ORG_EMAIL o cualquier DEV_ID.

Si actionAttribute se configura como WEBHOOK, establece este valor en el ID del webhook.

Si actionAttribute se configura como COMPANY_ADMINS, se ignora este valor y se envía una notificación a todos los administradores de la empresa.

No disponible
templateID

ID de la plantilla de notificación.

Nota: Esta opción no es válida si actionAttribute se establece en WEBHOOK.

No disponible
postURL

Controlador de devolución de llamada para el webhook.

Nota: Esta opción es obligatoria si actionAttribute está configurado como WEBHOOK. Esta opción no es válida si el valor se establece en ORG_EMAIL, DEV_ID o COMPANY_ADMINS.

No disponible

Usa variables en plantillas de notificación

Cuando editas el mensaje en una plantilla de notificación, puedes incluir una o más variables con Spring Expression Language (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} 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}

Hora o fecha en la que un límite vence o se restablece.

${LONG_PERCENT} 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, un 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 de tarifas)

${QUOTA_UNIT}

Unidad básica para un límite: moneda (para el límite de gasto) o llamadas (para el límite de transacción).

${QUOTA_LIMIT}

Cantidad de un límite.

${ratePlan.displayName} 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}

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} Fecha en la que se creó el plan de tarifas.
${USAGE} Uso actual (ingresos o cargos totales, o volumen).
${USER}

Es el nombre de un usuario.

Cómo personalizar tu dirección de correo electrónico de respuesta

En cuanto a 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 empresas y desarrolladores. Comunícate con el equipo de asistencia de Apigee si deseas configurar un nombre y una dirección de respuesta personalizados para tu organización.