配置通知

在线编辑

指定要用于电子邮件通知的发件人名称和电子邮件地址。 如有需要，您可以预览这些模板，并根据需要自定义文本。 您还可以对通知进行样式设置以与业务主题相匹配。

关于本任务

当发生某些系统事件时，会自动发送 API Manager 电子邮件。 范围决定了电子邮件模板的组织方式，具体说明见表1。
表 1. 通知范围
作用域 触发通知的事件
目录 与目录相关的活动；例如应用程序生命周期事件、目录邀请、产品审批以及订阅审批。
消费者 消费者目录中的消费者应用程序和订阅请求、消费者组织的邀请，以及消费者目录账户的密码重置请求。
提供程序 邀请。
空间 邀请。

电子邮件通知包含基于 API Connect中已配置的发件人详细信息的分层搜索的发件人名称和地址。 根据要发送的电子邮件模板，搜索可以从空间级别开始，然后进入目录，提供者组织和 Cloud Manager 级别。 所使用的发件人详细信息是此次分层搜索中找到的第一组已配置的详细信息。 要查看系统在查找每个通知模板的发件人详细信息时所采用的搜索 API Connect 路径，请参阅 《配置电子邮件通知的发件人详细信息 》。

需要以下某个角色才能配置电子邮件通知：

  • 管理员
  • 所有者
  • 具有 Settings:Manage 许可权的定制角色
注: 您还可以使用 developer toolkit CLI 或 API Connect REST API 来定制通知。 如需了解更多信息，请参阅 API 开发和管理命令 或 API Connect REST API。

过程

  1. 在 API 管理器中 ，点击 设置 “设置”。
  2. 在 设置 导航列表中，单击 通知，然后单击 编辑。
  3. 通过输入 名称 和 电子邮件地址来指定发件人，然后单击 保存。
    要在空间或目录级别配置发送方详细信息，必须使用 developer toolkit CLI。 如需更多信息，请参阅 《配置电子邮件通知的发件人信息》。
  4. 可选： 若要启用模板自定义功能，请将“自定义通知模板 ”滑块移至 “开启 ”位置。
    注意： 您可以通过禁用并重新启用模板自定义功能，重新加载云管理员配置的所有默认通知。 但是，这样做会覆盖之前所做的任何自定义设置。
  5. 要预览模板中的文本，请从模板名称旁边的 选项菜单图标 选项菜单中选择 “预览”。
  6. 要编辑模板的文本，请单击模板名称，或者在模板名称旁边的选项菜单中选择 编辑 。

    打开模板时，会尝试从浏览器设置获取语言，但如果这不可能，那么模板缺省为英语。

    文本包含变量，例如 {{catalog}}。 通知文本基于 Handlebar 语法。 大多数变量都用双大括号括起来 {{ }} ，但也可以用三大括号括起来 {{{ }}} ，以禁用 HTML 转义，例如当变量是 URL 链接时。 有关 handlebars 的更多信息，请参阅 https://handlebarsjs.com/。

    要获取可用于特定通知模板的变量的完整列表，请完成以下步骤：
    1. 请以提供商组织的成员身份，通过命令行登录管理服务器。 如需更多信息，请参阅 “登录管理服务器 ”。 您可以在登录命令中使用与登录 API Manager 用户界面时相同的管理服务器 URL、用户名和密码。
    2. 输入以下命令：
      apic notification-templates:get template_name --server mgmt_endpoint_url --scope org --org provider_organization --subcollection template_scope --fields variables --output -
      其中：
      • template_name 是所需通知模板的名称，如用户界面的模板列中所显示。
      • template_scope 是该模板旁边的作用域列中显示的作用域名称。
      • provider_organization 是提供者组织的 name 字段的值。
      例如，
      apic notification-templates:get member-invitation --server https://myserver.com --scope org --org myorg --subcollection catalog --fields variables --output -
      将显示可用于模板的变量，例如:
      variables:
  - org
  - catalog
  - activationLink
  - expiresAt
  - originator
  - originatorFirstName
  - originatorLastName
  - originatorEmail
  - username
  - email
  - firstName
  - lastName

      --output - 参数导致将命令输出写入到命令行。 您可以指定 --output filepath 以将输出写入指定位置的 .yaml 文件，或者完全省略它以将文件写入当前文件夹。

  7. 要以其他语言查看和编辑通知模板，请从 在 下拉列表中查看模板，选择下列其中一种受支持的语言:
    • 中文（简体）
    • 中文（繁体）
    • 捷克语
    • 荷兰语
    • 英语 (美国英语)
    • 法语
    • 德语
    • 意大利语
    • 日语
    • 韩语
    • 波兰语
    • 葡萄牙语
    • 俄语
    • 西班牙语
    • 土耳其语
  8. 根据需要编辑 主题 。
  9. 从HTML、PlainText 或两者中选择要用于模板的内容类型。 默认内容类型为PlainText。
    将显示所选内容类型的编辑窗口，或者如果选择了 两者 ，那么将同时显示这两个编辑窗口。
  10. 根据需要编辑模板主体。
    对于 HTML 内容，只允许使用下表中显示的标记及其属性。
    表 2. 允许的 HTML 标签和属性
    HTML 标记 属性
    <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"
    如果在通知中使用了不允许的 HTML 标记，那么该标记及其内容将以纯文本形式显示在电子邮件中。

    可以通过在模板中添加 <img src="https://path/to/image.png"/> 标记来使用图像。 图片的 src 属性必须是一个完全合格的 Web URL ，并且必须可以从外部访问，以便电子邮件收件人可以访问图片。 无法引用本地图片。 它们必须是完整的URL。 也无法在电子邮件中嵌入或附加图像或其他文件。

  11. 完成后单击 保存 。
    注: 仅针对已编辑的特定语言版本保存对模板进行的编辑。