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

Artículo
06/02/2023

API Management le ofrece la posibilidad de configurar notificaciones de eventos específicos, así como 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.

En Azure Portal, busque y seleccione Servicios de API Management.
En la página de servicios API Management, seleccione la instancia de API Management.

Configuración de notificaciones en el portal

En el panel de navegación izquierdo de la instancia de API Management, seleccione Notificaciones para ver las notificaciones disponibles.

Se puede configurar la siguiente lista de eventos para notificaciones.
- Solicitudes de suscripción (se requiere aprobación): los destinatarios y usuarios de correo electrónico especificados recibirán notificaciones por correo electrónico sobre solicitudes de suscripción de productos que requieran aprobación.
- Nuevas suscripciones: los destinatarios y usuarios de correo electrónico especificados recibirán notificaciones por correo electrónico sobre nuevas suscripciones de productos.
- CCO : los destinatarios y usuarios de correo electrónico especificados recibirán copias carbón ocultas de todos los correos electrónicos enviados a los desarrolladores.
- Cerrar mensaje de cuenta : los destinatarios y usuarios de correo electrónico especificados recibirán notificaciones por correo electrónico cuando se cierre una cuenta.
- Aproximación al límite de cuota de suscripción: los destinatarios y usuarios de correo electrónico especificados recibirán notificaciones por correo electrónico cuando el uso de la suscripción se acerque a la cuota de uso.
  
  Nota
  
  Solo la directiva de cuota por suscripción desencadena las notificaciones. La directiva de cuota por clave no genera notificaciones.
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:

Envío de la galería de aplicaciones aprobado (en desuso)
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
Nuevo comentario agregado a un problema (en desuso)
Confirmación de nueva cuenta de desarrollador
Nuevo problema recibido (en desuso)
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 un asunto en texto sin formato y una definición del 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:

En el menú de la izquierda, seleccione Plantillas de notificación.
Seleccione una plantilla de notificación y configúrela mediante el editor.
- La lista Parámetros contiene una lista de parámetros que, al insertarlos en el asunto o en el cuerpo, se reemplazarán por el valor designado cuando se envíe 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.
Para guardar los cambios efectuados en la plantilla de correo electrónico, haga clic en Guardar o, si quiere cancelarlos, haga clic en Descartar.

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 puede 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:

En el menú de la izquierda, seleccione Plantillas de notificación.
Seleccione Configuración de correo electrónico.
En la página Configuración de correo electrónico general, escriba los valores para:
- Correo electrónico del administrador: es la dirección de correo electrónico para recibir todas las notificaciones del sistema y otras notificaciones configuradas.
- Nombre de la organización: es el nombre de su organización que usará en el portal para desarrolladores y las notificaciones.
- Dirección de correo electrónico de origen: es el 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.
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.

Cambiar a Dirección de origen: al cambiar la dirección de correo electrónico de origen (por ejemplo, a no-reply@contoso.com), el encabezado de dirección From 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 establecido en la carpeta de correo no deseado: es posible que algunos destinatarios no reciban las notificaciones por correo electrónico de API Management, o bien puede que los correos electrónicos se envíen a la carpeta de 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 deje de admitir la autenticación SPF después de cambiar el dominio de dirección del 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, comuníquese 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.