Configuración de notificaciones y plantillas de correo electrónico en Azure API Management

SE APLICA A: Desarrollador | Básico | Básico v2 | Estándar | Standard v2 | Premium |Premium v2

Azure API Management permite configurar notificaciones por correo electrónico para eventos específicos y configurar las plantillas de correo electrónico que se usan para comunicarse con los administradores y desarrolladores de una instancia de API Management. Este artículo muestra cómo configurar las notificaciones de los eventos disponibles y ofrece información general sobre la configuración de plantillas de correo electrónico que se usan para estos eventos.

Requisitos previos

Si no tiene una instancia del servicio de API Management, complete el tutorial siguiente: Creación de una instancia de Azure API Management.

Vaya a la instancia de API Management.

1. En Azure Portal, busque y seleccione Servicios de API Management:

   

2. En la página Servicios de API Management , seleccione la instancia de API Management:

   

Configuración de notificaciones en Azure Portal

1. En el menú de la barra lateral de la instancia de API Management, seleccione Implementación y infraestructura y, a continuación, elija Notificaciones para ver las notificaciones disponibles.

   Se puede configurar la siguiente lista de eventos para notificaciones.

   • Solicitudes de suscripción (que requieren aprobación): los destinatarios de correo electrónico y los usuarios especificados reciben notificaciones por correo electrónico sobre las solicitudes de suscripción para los productos que requieren aprobación.
   • Nuevas suscripciones: los destinatarios de correo electrónico y los usuarios especificados reciben notificaciones por correo electrónico sobre las nuevas suscripciones de producto.
   • Solicitudes de la galería de aplicaciones: los siguientes destinatarios de correo electrónico y usuarios reciben notificaciones por correo electrónico cuando se envían nuevas aplicaciones a la galería de aplicaciones.
   • BCC: los destinatarios de correo electrónico y los usuarios especificados reciben copias de carbono ciegas de correo electrónico de todos los correos electrónicos enviados a los desarrolladores.
   • Nuevo problema o comentario: los siguientes destinatarios de correo electrónico y usuarios reciben notificaciones por correo electrónico cuando se envía un nuevo problema o comentario en el portal para desarrolladores.
   • Cerrar mensaje de cuenta: los destinatarios de correo electrónico y los usuarios especificados reciben notificaciones por correo electrónico cuando se cierra una cuenta.
   • Aproximación al límite de cuota de suscripción: los destinatarios de correo electrónico y los usuarios especificados reciben notificaciones por correo electrónico cuando el uso de la suscripción se acerca a la cuota de uso.

2. Seleccione una notificación y especifique una o varias direcciones de correo electrónico que se vayan a notificar:

   • Para agregar la dirección de correo electrónico del administrador, seleccione + Agregar administrador.
   • Para agregar otra dirección de correo electrónico, seleccione + Agregar correo electrónico, escriba una dirección de correo electrónico y seleccione Agregar.
   • Siga agregando direcciones de correo electrónico según sea necesario.

   

Configuración de plantillas de notificación

API Management proporciona plantillas de notificación para los mensajes de correo electrónico administrativos que se envían automáticamente a los desarrolladores cuando acceden al servicio y lo usan. Se proporcionan las siguientes plantillas de notificación:

• Carta de despedida del desarrollador
• Notificación de aproximación del límite de cuota del desarrollador
• Carta de bienvenida del desarrollador
• Notificación de cambio de correo electrónico
• Invitación a un usuario
• Confirmación de nueva cuenta de desarrollador
• Nueva suscripción activada
• Confirmación de cambio de contraseña
• Rechazo de la solicitud de suscripción
• Solicitud de suscripción recibida

Cada plantilla de correo electrónico tiene una línea de asunto en texto sin formato y una definición de cuerpo en formato HTML. Cada elemento se puede personalizar según se desee.

Nota

El contenido HTML de una plantilla debe tener un formato correcto y cumplir la especificación XML. No se permite el carácter  .

Para ver y configurar una plantilla de notificación en el portal:

1. En el menú de la barra lateral, seleccione Plantillas de notificación.

2. Seleccione una plantilla de notificación y configúrela mediante el editor.

   

   • La lista Parámetros contiene una lista de parámetros que, cuando se insertan en el asunto o el cuerpo, se reemplazan por el valor designado cuando se envía el correo electrónico.
   • Para insertar un parámetro, sitúe el cursor en donde desee que vaya el parámetro y seleccione el nombre del parámetro.

3. Para guardar los cambios en la plantilla de correo electrónico, seleccione Guardar o seleccione Descartar para cancelar los cambios.

Configuración de las opciones de correo electrónico

Puede modificar la configuración de correo electrónico general para las notificaciones enviadas desde la instancia de API Management. Puede cambiar la dirección de correo electrónico del administrador, el nombre de la organización que envía la notificación y la dirección de correo electrónico de origen.

Importante

Cambiar la dirección de correo electrónico de origen podría afectar a la capacidad de los destinatarios de recibir correo electrónico. Consulte las consideraciones de la sección siguiente.

Para modificar la configuración de correo electrónico:

1. En el menú de la barra lateral, seleccione Plantillas de notificación.

2. Seleccione Configuración de correo electrónico.

3. En la página Configuración general de correo electrónico , escriba los valores de:

   • Correo electrónico de administrador: la dirección de correo electrónico para recibir todas las notificaciones del sistema y otras notificaciones configuradas.

   • Nombre de la organización: el nombre de su organización para su uso en el portal para desarrolladores y las notificaciones.

   • Dirección de correo electrónico de origen: valor del encabezado From para las notificaciones de la instancia de API Management. API Management envía notificaciones en nombre de esta dirección de origen.

     

4. Seleccione Guardar.

Consideraciones para cambiar la dirección de correo electrónico de origen

Los destinatarios de las notificaciones por correo electrónico de API Management podrían verse afectados al cambiar la dirección de correo electrónico de origen.

• Cambie la dirección De: al cambiar la dirección de correo electrónico de origen (por ejemplo, a no-reply@contoso.com), el encabezado de dirección De será noreply@contoso.com apimgmt-noreply@mail.windowsazure.com. Esto se debe a que es API Management quien envía el correo electrónico, no el servidor de correo electrónico de la dirección de correo electrónico de origen.

• Correo electrónico enviado a la carpeta de correo no deseado o correo no deseado: es posible que algunos destinatarios no reciban las notificaciones por correo electrónico de API Management, o que los correos electrónicos se envíen a la carpeta de correo no deseado o correo no deseado. Esto puede ocurrir en función de la configuración de autenticación de correo electrónico de SPF o DKIM de la organización:

  • Autenticación SPF: es posible que el correo electrónico ya no pase la autenticación SPF después de cambiar el dominio de dirección de correo electrónico de origen. Para garantizar la autenticación SPF y la entrega de correo electrónico de forma correcta, cree el siguiente registro TXT en la base de datos DNS del dominio especificado en la dirección de correo electrónico. Por ejemplo, si la dirección de correo electrónico es noreply@contoso.com, póngase en contacto con el administrador de contoso.com para agregar el siguiente registro TXT: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

  • Autenticación DKIM: para generar una firma válida para DKIM para la autenticación de correo electrónico, API Management requiere la clave privada asociada al dominio de la dirección de correo electrónico de origen. Sin embargo, actualmente no es posible cargar esta clave privada en API Management. Por tanto, para asignar una firma válida, API Management usa la clave privada asociada al dominio mail.windowsazure.com.

Contenido relacionado

• Información general del portal para desarrolladores
• Creación y uso de grupos para administrar cuentas de desarrollador