Compartir a través de

如何在 Azure API 管理中配置通知和通知模板

  • Artículo

API 管理提供的功能为特定事件配置电子邮件通知，以及配置用于和 API 管理实例的管理员及开发人员通信的电子邮件模板。 本文演示如何为可用事件配置通知，并提供配置用于这些事件的电子邮件模板的概述。

先决条件

如果没有 API 管理服务实例，请完成以下快速入门：创建 Azure API 管理实例。

转到你的 API 管理实例

  1. 在 Azure 门户中搜索并选择“API 管理服务” 。

    选择“API 管理服务”

  2. 在“API 管理”服务页上，选择你的 API 管理实例。

    选择你的 API 管理实例

在门户中配置通知

  1. 在 API 管理实例的左侧导航栏中，选择“通知”以查看可用的通知。

    为通知可以配置以下事件的列表。

    • 订阅请求（需要批准）- 指定的电子邮件收件人和用户将收到关于需要批准的产品的订阅请求的电子邮件通知。
    • 新订阅 - 指定的电子邮件收件人和用户将收到关于新产品订阅的电子邮件通知。
    • BCC - 指定电子邮件收件人和用户将收到发送给开发人员的所有电子邮件的电子邮件密件副本。
    • 关闭帐户消息 - 指定电子邮件收件人和用户会在关闭帐户时收到电子邮件通知。
    • 接近订阅配额限制 - 当订阅使用量接近使用量配额时，指定的电子邮件收件人和用户将收到电子邮件通知。

  2. 选择一种通知，并指定要通知的一个或多个电子邮件地址：

    • 若要添加管理员电子邮件地址，请选择“+ 添加管理员”。
    • 若要添加其他电子邮件地址，请选择“+ 添加电子邮件”，输入电子邮件地址，然后选择“添加”。
    • 根据需要继续添加电子邮件地址。

    屏幕截图显示如何在门户中添加通知收件人

配置通知模板

API 管理提供管理电子邮件通知模板，当开发人员访问和使用服务时，系统会自动向他们发送这些电子邮件。 提供以下通知模板：

  • 批准的应用程序库提交内容（已弃用）
  • 开发人员告别字母
  • 开发人员配额限制接近通知
  • 开发人员欢迎信
  • 电子邮件更改通知
  • 邀请用户
  • 添加到问题的新注释（已弃用）
  • 新的开发人员帐户确认
  • 收到新问题（已弃用）
  • 激活的新订阅
  • 密码更改确认
  • 已拒绝订阅请求
  • 接收的订阅请求

每个电子邮件模板都有纯文本格式的主题，和 HTML 格式的正文定义。 可按需自定义每一项。

注意

模板中的 HTML 内容必须格式正确并符合 XML 规范。 不允许使用   字符。

若要在门户中查看和配置通知模板，请执行以下操作：

  1. 在左侧菜单中，选择“通知模板”。 屏幕截图显示门户中的通知模板

  2. 选择一个通知模板，然后使用编辑器配置该模板。

    屏幕截图显示门户中的通知模板编辑器

    • “参数”列表包含参数列表，插入到主题或正文时，会在发送电子邮件时替换为指定的值。
    • 若要插入某个参数，请将光标放在要插入该参数的位置，然后选择该参数的名称。

  3. 若要保存对电子邮件模板所做的更改，请选择“保存”；若要取消更改，请选择“放弃”。

配置电子邮件设置

可以修改从 API 管理实例发送的通知的常规电子邮件设置。 可以更改管理员电子邮件地址、发送通知的组织名称以及来源电子邮件地址。

重要

更改原始电子邮件地址可能会影响收件人接收电子邮件的能力。 请参阅以下部分中的 注意事项。

若要修改电子邮件设置，请执行以下操作：

  1. 在左侧菜单中，选择“通知模板”。
  2. 选择“电子邮件设置”。
  3. 在“常规电子邮件设置”页上，输入以下项的值：

    • 管理员电子邮件 - 要接收所有系统通知和其他已配置的通知的电子邮件地址

    • 组织名称 - 要在开发人员门户和通知中使用的组织名称

    • 来源电子邮件地址 - 来自 API 管理实例的通知的 From 标头值。 API 管理将代表此来源地址发送通知。

      屏幕截图显示门户中的 API 管理电子邮件设置

  4. 选择“保存” 。

更改原始电子邮件地址的注意事项

更改原始电子邮件地址时，来自 API 管理的电子邮件通知的收件人可能会受到影响。

  • 更改为发件人地址 - 更改原始电子邮件地址（更改为 no-reply@contoso.com）时， From 地址标头将为 noreply@contoso.com apimgmt-noreply@mail.windowsazure.cn。 这是因为电子邮件由 API 管理（而非原始电子邮件地址的电子邮件服务器）发送。

  • 电子邮件设置为“垃圾邮件”文件夹 - 一些收件人可能收不到来自 API 管理的电子邮件通知，或者电子邮件可能会发送到“垃圾邮件”文件夹。 可能会发生这种情况，具体取决于组织的 SPF 或 DKIM 电子邮件身份验证设置：

    • SPF 身份验证 - 更改原始电子邮件地址域后，电子邮件可能无法再通过 SPF 身份验证。 要确保 SPF 身份验证和电子邮件传递成功，请在电子邮件地址中指定的域的 DNS 数据库中创建以下 TXT 记录。 例如，如果电子邮件地址为 noreply@contoso.com，请联系 contoso.com 的管理员添加以下 TXT 记录："v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"

    • DKIM 身份验证 - 要生成用于电子邮件身份验证的有效 DKIM 签名，API 管理需有与原始电子邮件地址的域关联的私钥。 但是，目前无法在 API 管理中上传此私钥。 因此，为了分配有效签名，API 管理使用与 mail.windowsazure.cn 域关联的私钥。

后续步骤