Configuración de notificaciones

Especifique el nombre del remitente y la dirección de correo electrónico que se van a utilizar para las notificaciones de correo electrónico. Si es necesario, puedes previsualizar las plantillas y personalizar el texto si lo necesitas. También puede dar estilo a las notificaciones para que coincidan con el tema de negocio.

Acerca de esta tarea

Los correos electrónicos de Gestor de API se envían automáticamente cuando se producen determinados sucesos del sistema. El ámbito determina cómo se organizan las plantillas de correo electrónico, tal y como se explica en la tabla 1.
Tabla 1. Ámbitos de notificación
Ámbito Sucesos que desencadenan la notificación
catálogo Actividades relacionadas con los catálogos, tales como eventos del ciclo de vida de las aplicaciones, invitaciones a catálogos, aprobaciones de productos y aprobaciones de suscripciones.
consumidor Acciones relacionadas con las solicitudes de aplicaciones y suscripciones en el Catálogo para consumidores, invitaciones a organizaciones de consumidores y solicitudes de restablecimiento de contraseña para cuentas del Catálogo para consumidores.
proveedor Invitaciones.
Espacio Invitaciones.

Las notificaciones de correo electrónico contienen un nombre de remitente y una dirección que se basan en una búsqueda jerárquica de los detalles del remitente configurados en API Connect. En función de la plantilla de correo electrónico que se envíe, la búsqueda puede empezar en el nivel Espacio y, a continuación, pasar por los niveles Catálogo, Organización de proveedores y Gestor de nube. Los datos del remitente que se utilizan son el primer conjunto de datos configurados que se encuentra durante esta búsqueda jerárquica. Para ver qué ruta de búsqueda API Connect se sigue al buscar los datos del remitente para cada plantilla de notificación, consulta «Configuración de los datos del remitente para las notificaciones por correo electrónico ».

Se necesita uno de los roles siguientes para configurar las notificaciones de correo electrónico:

  • Administrador
  • Propietario (Owner)
  • Un rol personalizado con el permiso Settings:Manage
Nota: También puede personalizar las notificaciones utilizando la CLI del kit de herramientas del desarrollador o utilizando las API REST de API Connect . Para obtener más información, consulta los comandos de desarrollo y gestión de API o las API Connect API REST.

Procedimiento

  1. En API Manager, haz clic en Valores «Configuración».
  2. En la lista de navegación Valores , pulse Notificacionesy, a continuación, pulse Editar.
  3. Especifique un remitente especificando un Nombre y una Dirección de correo electrónicoy, a continuación, pulse Guardar.
    Para configurar los detalles del remitente en los niveles Espacio o Catálogo, debe utilizar la CLI developer toolkit . Para obtener más información, consulta «Configuración de los datos del remitente para las notificaciones por correo electrónico ».
  4. Opcional: Para habilitar la personalización de plantillas, mueve el control deslizante «Personalizar plantillas de notificación » a la posición «Activado ».
    Nota: Puedes volver a cargar todas las notificaciones predeterminadas, tal y como las haya configurado el administrador de la nube, desactivando y volviendo a activar la personalización de plantillas. Sin embargo, al hacerlo se sobrescribirán todas las personalizaciones que se hayan realizado.
  5. Para obtener una vista previa del texto de una plantilla, selecciona «Vista previa» en el menú de opciones Icono de menú de opciones situado junto al nombre de la plantilla.
  6. Para editar el texto de la plantilla, pulse el nombre de la plantilla o seleccione Editar en el menú de opciones junto al nombre de la plantilla.

    Cuando se abre una plantilla, se intenta obtener el idioma de la configuración del navegador, pero si esto no es posible, la plantilla se establece de forma predeterminada en inglés.

    El texto incluye variables; por ejemplo, {{catalog}}. El texto de la notificación se basa en la sintaxis de Handlebars. La mayoría de las variables se encierran entre llaves dobles {{ }}, pero pueden encerrarse entre llaves triples {{{ }}} para desactivar el escape HTML, cuando la variable es un enlace URL, por ejemplo. Para obtener más información sobre los manillares, consulta https://handlebarsjs.com/.

    Para obtener la lista completa de variables que están disponibles para una plantilla de notificación determinada, realice los pasos siguientes:
    1. Inicie sesión en el servidor de administración desde la línea de comandos como miembro de una organización proveedora. Para obtener más información, consulte «Iniciar sesión en un servidor de gestión ». Puedes utilizar el mismo servidor de gestión URL, nombre de usuario y contraseña en el comando de inicio de sesión que utilizas para acceder a la interfaz de usuario de API Manager.
    2. Escriba el mandato siguiente:
      apic notification-templates:get template_name --server mgmt_endpoint_url --scope org --org provider_organization --subcollection template_scope --fields variables --output -
      Donde:
      • template_name es el nombre de la plantilla de notificación necesaria, tal como se muestra en la columna Plantilla de la interfaz de usuario.
      • template_scope es el nombre de ámbito que se muestra en la columna Ámbito junto a esa plantilla.
      • provider_organization es el valor del campo name para la organización de proveedores.
      Por ejemplo:
      apic notification-templates:get member-invitation --server https://myserver.com --scope org --org myorg --subcollection catalog --fields variables --output -
      Se muestran las variables disponibles para la plantilla, por ejemplo:
      variables:
        - org
        - catalog
        - activationLink
        - expiresAt
        - originator
        - originatorFirstName
        - originatorLastName
        - originatorEmail
        - username
        - email
        - firstName
        - lastName

      El parámetro --output - hace que la salida del mandato se grabe en la línea de mandatos. Puede especificar --output filepath para que la salida se grabe en un archivo .yaml en la ubicación especificada, u omitirla por completo para que se grabe un archivo en la carpeta actual.

  7. Para ver y editar la plantilla de notificación en un idioma diferente, seleccione uno de los siguientes idiomas soportados en la lista desplegable Ver plantilla en :
    • Chino (Simplificado)
    • Chino (Tradicional)
    • Checo
    • Holandés
    • Inglés (Inglés de Estados Unidos)
    • Francés
    • Alemán
    • Italiano
    • Japonés
    • Coreano
    • Polaco
    • Portugués
    • Ruso
    • Español
    • Turco
  8. Edite el Asunto según sea necesario.
  9. ' Seleccione el Tipo de contenido que desea utilizar para la plantilla, entre HTML, Texto sin formato o Ambos. El tipo de contenido por defecto es PlainText.
    Se visualiza una ventana de edición para el tipo de contenido seleccionado, o se visualizan ambas ventanas de edición si se selecciona Ambas .
  10. Edite el cuerpo de la plantilla según sea necesario.
    Para el contenido HTML, sólo se permiten las etiquetas y sus atributos que se muestran en la tabla siguiente.
    Tabla 2. Etiquetas y atributos HTML permitidos
    Código HTML Atributo
    <a> "class", "href", "hreflang", "style"
    <em> "class", "style"
    <strong> "class", "style"
    <cite> "class", "style"
    <blockquote> "class", "cite", "style"
    <code> "class", "style"
    <ul> "class", "type", "style"
    <ol> "class", "start", "type", "style"
    <li> "class", "style"
    <dl> "class", "style"
    <dt> "class", "style"
    <dd> "class", "style"
    <h1> "class", "id", "style"
    <h2> "class", "id", "style"
    <h3> "class", "id", "style"
    <h4> "class", "id", "style"
    <h5> "class", "id", "style"
    <h6> "class", "id", "style"
    <p> "class", "style"
    <div> "class", "style"
    <br> "class", "style"
    <span> "class", "style"
    <img> "class", "src", "alt", "data-entity-type", "data-entity-uuid", "data-align", "data-caption", "width", "height", "style"
    <table> "class", "id", "style"
    <tr> "class", "id", "style"
    <td> "class", "id", "style"
    Si una etiqueta HTML que no está permitida se utiliza en una notificación, la etiqueta y su contenido se muestran en el correo electrónico como texto sin formato.

    Las imágenes se pueden utilizar añadiendo una etiqueta <img src="https://path/to/image.png"/> en la plantilla. El atributo src de la imagen debe ser una dirección web completa URL, y debe ser accesible desde el exterior para que los destinatarios del correo electrónico puedan acceder a la imagen. No es posible hacer referencia a imágenes locales. Deben ser direcciones URL completas. Tampoco es posible incrustar o adjuntar imágenes u otros archivos en los correos electrónicos.

  11. Haga clic en Guardar cuando haya terminado.
    Nota: Las ediciones realizadas en una plantilla sólo se guardan para la versión de idioma específica que se edita.