Cómo configurar notificaciones mediante plantillas de notificaciones

Estás viendo la documentación de Apigee Edge.
Ir 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 hacer lo siguiente:

• Notificar a todos los desarrolladores sobre eventos, como productos nuevos, versiones nuevas de los C.G. 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 un desarrollador se registra para obtener 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 activa 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.

Cómo editar notificaciones

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

1. Accede a la página Notificaciones.
2. Haz clic en junto a la notificación que deseas 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 en una plantilla de notificación, consulta Usa variables en plantillas de notificación.

   Consulta las siguientes secciones para obtener más información sobre cómo editar las notificaciones en cada categoría:

   • Edición de notificaciones para Notificar a todos los desarrolladores
   • Cómo editar las notificaciones para notificar a los desarrolladores afectados
   • Cómo editar notificaciones para los proveedores de APIs
4. Para habilitar una notificación, selecciona la casilla de verificación junto a ella.
5. Repite los pasos del 2 al 4 para editar notificaciones adicionales.
6. Haz clic en Guardar para guardar todos los cambios.

Se mostrará un mensaje para confirmar que se guardaron las notificaciones. La operación de guardar puede tardar unos minutos.

Se editaron las notificaciones para notificar a todos los desarrolladores

Las notificaciones de los tipos de eventos que selecciones en la sección Notify All Developers se envían a todos los desarrolladores.

Las notificaciones están programadas para ejecutarse al final del día. Después de que se envían las notificaciones, las casillas de verificación de los eventos se borran automáticamente. Deberás volver a seleccionarlos para programar notificaciones sobre los tipos de eventos asociados.

En la siguiente tabla, se enumeran 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.

Se editaron las 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 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 Notifica a los desarrolladores afectados. Para obtener más información, consulta Cómo editar notificaciones con la IU.

Edición de notificaciones para proveedores de APIs

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 de la sección Proveedor de la API de Notify. Para obtener más información, consulta Cómo editar notificaciones con la IU.

Cómo 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. Para habilitar o inhabilitar una notificación, selecciona o anula la selección de la casilla de verificación adyacente, respectivamente.
3. Haz clic en Guardar para guardar todos los cambios.

La operación de guardar puede tardar unos minutos. Se mostrará un mensaje para confirmar que se guardaron las notificaciones.

Configura notificaciones con plantillas a través de 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 notificación con la API
• Cómo ver una plantilla de notificación con la API
• Cómo editar una plantilla de notificación con la API

Visualiza todas las plantillas de notificación con la API

Puedes enumerar todas las plantillas de notificación que proporciona la monetización si envías 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
}

Visualiza 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}, donde {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 notificaciones. Supón que las variables de la notificación se evalúan con 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"

Edita una plantilla de notificación con la API

Edita una plantilla de notificación enviando una solicitud PUT a /nint/organizations/{org_name}/notification-email-templates/{template_id}. Proporciona el contenido cambiado 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 Usa variables en plantillas de notificaciones.

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

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.

• Crea una condición y una acción de notificación con la API
• Cómo 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

Crea una condición y una acción de notificación que generen una notificación automática con 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 atributos. Consulta Propiedades de configuración para las condiciones de notificación 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 el actions, haz referencia a 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 es NEW_PRODUCT y el valor del atributo PUBLISHED es true, se envíe 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

Visualiza 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}, donde {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"
    } ]
    }

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

Edita una condición y una acción de notificación enviando una solicitud POST a organizations/{org_name}/notification-conditions/{condition_Id}, donde {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

Borra 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 notificación

Cuando usas la API, están disponibles las siguientes propiedades de configuración para las condiciones de notificación.

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.

Cómo usar 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 de uso frecuente.

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

Para la monetización, se configura una dirección predeterminada noreply@apigee.com para usarla en las notificaciones por correo electrónico que se envían a las empresas y los desarrolladores. Comunícate con el equipo de asistencia de Apigee para configurar un nombre y una dirección de respuesta personalizados para tu organización.