Apigee Integration 和 API 触发器

本快速入门介绍了如何在 Apigee Integration 中创建示例集成。以下步骤介绍了如何配置运行完整集成所需的触发器、任务、边缘、变量和数据映射。

在本快速入门中，您将从公共 API 检索页面浏览量，将数据转换为可用格式，以及通过电子邮件发送结果列表，所有这些操作都在集成设计器中完成。

创建新的集成

如需创建新的集成，请执行以下步骤：

  1. 在 Apigee 界面中，选择您的 Apigee 组织。
  2. 点击开发 > 集成。
  3. 点击创建集成。
  4. 在创建 Integrations对话框中输入名称和说明。

    对于本快速入门，请输入名称 my-test-integration 和说明 Integration for quickstart。

  5. 选择集成的区域。
  6. 点击创建以打开集成编辑器。

添加和配置 API 触发器

需要触发器才能启动构成集成的任务序列。任何可用的触发器都可以用来启动集成。对于本快速入门，请使用 API 触发器。

如需配置 API 触发器，请执行以下操作：

  1. 在集成编辑器中，点击触发器以显示可用触发器列表。
  2. 点击 API 触发器元素，并将其放入集成编辑器中。
  3. 点击设计器上的 API 触发器元素以打开触发器配置窗格。
  4. Apigee Integration 会自动填充触发器标签、触发器名称和触发器 ID。触发器 ID 由机器生成，您无法修改该值。但是，您可以修改标签和触发器名称属性的值。

    系统会自动保存对属性的更改。

添加和配置任务

任务是一组可执行的步骤，可将变量作为输入以及生成变量作为输出。与触发器一样，任何可用的任务都可用于集成。本快速入门使用调用 REST 端点、数据映射和发送电子邮件任务。以下步骤介绍了每个任务的配置详情。

配置“调用 REST 端点”任务

如需配置调用 REST 端点任务，请执行以下操作：

  1. 选择任务以显示可用任务的列表。
  2. 点击调用 REST 端点元素，并将其放入集成编辑器中。
  3. 如需添加从 API 触发器元素到调用 REST 端点元素的边缘连接，请将控制点悬停在 API 触发器元素上，然后点击线条并将其拖到调用 REST 端点任务元素上的控制点。边缘表示从 API 触发器到调用 REST 端点任务的控制流。

    边缘是集成中的任何两个元素之间的连接。 连接表示从一个元素（任务或触发器）到另一个元素的控制流方向。如需详细了解边缘，请参阅边缘。

  4. 点击设计器上的调用 REST 端点元素以打开任务配置窗格。设置以下属性：
    • 标签：输入此任务的自定义名称。例如，输入 Call REST Endpoint Task。
    • 身份验证：此快速入门不需要身份验证配置文件。如需详细了解如何将身份验证配置文件用于其他使用场景，请参阅在 Apigee Integration 中创建身份验证配置文件。
    • 任务输入：输入调用 REST 端点的详细信息。此处输入的信息将用作调用 REST 端点任务的输入。输入以下信息：
      • 端点基准网址：输入 https://wikimedia.org/api/rest_v1/metrics/pageviews/per-article/en.wikipedia/desktop/user/Tree/monthly/20201001/20201031。wikimedia.org 中的公共 API 会返回给定月份名为 Tree 的文章的网页浏览量。
      • HTTP 方法：使用下拉列表选择 GET。
    • 任务输出：Apigee Integration 在此处填充三个变量，以保存调用 REST 端点的响应数据输出：
      • responseHeader(Call REST Endpoint)：此变量保存与调用 REST 端点任务关联的响应标头数据。变量数据的类型为 String（字符串）。
      • responseBody(Call REST Endpoint)：此变量保存与调用 REST 端点任务关联的响应正文数据。变量数据的类型为 String（字符串）。
      • responseStatus(Call REST Endpoint)：此变量保存与调用 REST 端点任务关联的响应状态数据。变量数据的类型为 String（字符串）。
    • 点击任务配置窗格中的变量名称即可查看每个变量的详细信息。在本快速入门中，其中每个变量都保留默认值。
    • 其余字段应包含以下默认值：
      • 遵循重定向：True
      • 任务应在出现 HTTP 错误时失败： False
      • 错误处理策略
        • 同步执行的策略：None
        • 异步执行的策略：None

    系统会自动保存对属性的更改。

添加并配置“数据映射”任务

如需配置数据映射任务，请执行以下操作：

  1. 选择任务以显示可用任务的列表。
  2. 点击数据映射元素，并将其放入集成编辑器中。
  3. 如需添加从调用 REST 端点元素到数据映射元素的边缘连接，请将控制点悬停在调用 REST 端点元素上，然后点击线条并将其拖动到数据映射任务元素上的控制点。边缘表示从调用 REST 端点任务到数据映射任务的控制流。
  4. 点击设计器上的数据映射任务以打开任务的配置窗格。
  5. 点击打开数据映射编辑器。

    借助数据映射编辑器，您可以使用可用的转换函数将输入变量映射为所需的输出变量。然后，输出可用作任何其他集成任务或触发器的变量。如需详细了解如何以变量形式传递数据，请参阅在 Apigee Integration 中使用变量。

    在本快速入门中，使用 responseBody(Call REST Endpoint) 作为输入来创建映射：

    1. 将 responseBody 变量从变量窗格拖动到第一个输入行。
    2. 点击 responseBody 变量条状标签中的 + (Add a function)（+ [添加函数]）以查看可用函数下拉列表。
    3. 您可以应用许多函数来转换输入变量中的数据。

      在这种情况下，您可以将载荷转换为 JSON，然后遍历响应数组，以获取电子邮件通知所需的产品名称列表。

      • 选择 TO_JSON() 将 responseBody 字符串转换为 JSON。
      • 点击 responseBody 变量条状标签中的 +（添加函数）以选择并链接 GET_PROPERTY() 函数。
      • 如需为 GET_PROPERTY() 添加输入参数，请点击变量或值，然后在值中输入 items。

        此函数将从 JSON 载荷中提取属性。传入 items 属性作为此函数的参数。此操作只会返回产品名称列表，而不会包含任何其他产品信息。您的函数应如下所示： 

        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(items)

      • 如果您需要移除或删除函数，请点击 - 符号。
    4. 点击输出列中的第一个字段，以创建一个新输出变量来保存转换后的数据的值。填写以下字段：
      • 名称：输入 JSONList。
      • 数据类型：JSON
      • 选中 Use as an output of integration（用作集成的输出）复选框。
      • 点击创建以创建变量并关闭窗格。新的 JSONList 变量将显示在数据映射编辑器左侧的变量列表中。
    5. 映射完成后，关闭数据映射编辑器。所有更改都将自动保存。

添加并配置“发送电子邮件”任务

如需配置发送电子邮件任务，请执行以下操作：

  1. 在集成编辑器中选择任务以显示可用任务列表。
  2. 点击发送电子邮件元素，并将其放入集成编辑器中。
  3. 如需添加从数据映射元素到发送电子邮件元素的边缘连接，请将控制点悬停在数据映射元素上，然后点击线条并将其拖动到发送电子邮件任务元素上的控制点。边缘表示从数据映射任务到发送电子邮件任务的控制流。
  4. 点击设计器上的发送电子邮件元素以打开任务的配置窗格。设置以下属性：
    • 收件人：输入您的电子邮件地址。您将使用此电子邮件来确认集成已成功完成。
    • 主题：输入 Email from Apigee Integration。
    • 纯文本正文：选择之前在数据映射任务中创建的 JSONList 变量。
    • 其余选项可以保留默认配置。

    系统会自动保存对属性的更改。

验证所需的边缘连接

验证您已在集成中的元素之间添加边缘连接。连接表示从一个元素（任务或触发器）到另一个元素的控制流方向。如需详细了解边缘，请参阅边缘。

已完成的连接应如下图所示：

显示快速入门流程的图片 显示快速入门流程的图片

测试集成

如需要测试新的集成，请执行以下操作：

  1. 点击集成编辑器工具栏中的测试。

    此时将显示测试集成窗格。

  2. 点击测试集成。

如需详细了解测试，请参阅测试和发布集成。

成功完成后，集成会将包含 JSON 值的电子邮件发送到发送电子邮件任务中指定的电子邮件地址。在电子邮件客户端中确认收到电子邮件。

集成发送的电子邮件应包含类似于以下内容的正文： 

[{
   "project": "en.wikipedia",
   "article": "Tree",
   "granularity": "monthly",
   "timestamp": "2020100100",
   "access": "desktop",
   "agent": "user",
   "views": 33828.0
}]

除了验证电子邮件内容之外，您还可以检查日志以查看给定集成的状态和载荷。要查看日志，请执行以下操作：

  1. 点击集成编辑器工具栏中的日志。
  2. 在执行日志页面上，您可以查看每次尝试运行集成的相关详细信息。每个条目都包含执行尝试的相关详细信息，其中包括：
    • 集成名称
    • 执行 ID
    • 状态
    • 开始时间
    • 时长
    • 集成版本
    • 触发器 ID
  3. 点击已执行集成旁边的展开箭头 (>)，以查看集成中任务和变量的扩展列表，以及任务状态和变量载荷。