Apigee Integration 入门

您正在查看 Apigee X 文档。
查看 Apigee Edge 文档。

本快速入门介绍如何使用 Apigee Integration 创建示例集成。以下步骤介绍了如何配置运行完整集成所需的触发器、任务、边缘、变量和数据映射。在本快速入门中,您将从网址端点检索产品列表,将数据转换为可用格式,以及通过电子邮件发送结果列表,所有这些操作都在集成设计器中完成。

准备工作

在开始学习本快速入门之前,请确认您的 Apigee 登录凭据和组织详细信息。如需访问设计器中的 Apigee Integration 功能,必须提供此信息。

创建新的集成

如需创建新的集成,请执行以下步骤:

  1. 转到 Apigee 界面并登录。
  2. 使用界面左上角的下拉菜单选择您的组织。
  3. 点击开发 > 集成
  4. 点击新建
  5. 创建 Integrations对话框中输入名称和说明。例如,my-test-integration
  6. 从支持的区域列表中选择集成的区域
  7. 点击创建以打开集成设计器。

配置触发器

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

如需配置 API 触发器,请执行以下操作:

  1. 在集成设计器中,选择添加任务/触发器 > 触发器以显示可用触发器列表。
  2. API 触发器元素拖动至集成设计器。
  3. 点击设计器上的 API 触发器元素以打开触发器配置窗格。
  4. Apigee Integration 会自动填充触发器标签触发器名称触发器 ID触发器 ID 由机器生成,您无法修改该值。但是,您可以修改标签触发器名称属性的值。

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

添加和配置任务

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

配置“调用 REST 端点”任务

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

  1. 选择添加任务/触发器 > 任务以显示可用任务列表。
  2. 调用 REST 端点元素拖动至集成设计器。
  3. 点击设计器上的调用 REST 端点元素以打开任务配置窗格。设置以下属性:
    • 标签:输入此任务的自定义名称。例如,输入 Call REST Endpoint Task
    • 身份验证:此快速入门不需要身份验证配置文件。如需详细了解如何将身份验证配置文件用于其他使用场景,请参阅在 Apigee Integration 中创建身份验证配置文件
    • 任务输入:输入调用 REST 端点的详细信息。此处输入的信息将用作调用 REST 端点任务的输入。输入以下信息:
      • 端点基准网址:输入 https://apigee-pm4-prod.apigee.net/v1/hipsters/products。 此端点会返回一个产品对象数组(每个对象都有一个 idnamedescriptionpictureprice)和 categories 的数组。
      • HTTP 方法:使用下拉列表选择 GET
      • 其他 HTTP 标头:输入访问端点所需的任何其他标头。在本快速入门中:
        • HTTP 标头键字段中输入 x-apikey
        • 字段中输入 H7WpkpvdCAC2jSffbmKpQLVduxC6nOO9
    • 任务输出:Apigee Integration 在此处填充三个变量,以保存调用 REST 端点的响应数据输出:
      • responseHeader(调用 REST 端点):此变量包含与调用 REST 端点任务关联的响应标头数据。变量数据的类型为 String(字符串)。
      • responseBody(调用 REST 端点):此变量包含与调用 REST 端点任务关联的响应正文数据。变量数据的类型为 String(字符串)。
      • responseStatus(调用 REST 端点):此变量包含与调用 REST 端点任务关联的响应状态数据。变量数据的类型为 String(字符串)。
    • 点击任务配置窗格中的变量名称即可查看每个变量的详细信息。在本快速入门中,其中每个变量都保留默认值。
    • 其余字段应包含以下默认值:
      • 遵循重定向True
      • 抛出错误False
      • 失败时重试
        • 当同步运行集成时None
        • 当异步运行集成时None

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

    已完成的配置应与下图一致:

    调用 REST 端点触发器

  4. 如需添加从 API 触发器元素到调用 REST 端点元素的边缘连接,请将控制点悬停在 API 触发器元素上,然后点击线条并将其拖到调用 REST 端点任务元素上的控制点。控制点和边缘线会变为黄色,如下图所示:

    显示边缘连接的集成设计器

    边缘表示从 API 触发器调用 REST 端点任务的控制流。

配置数据映射任务

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

  1. 选择添加任务/触发器 > 任务以显示可用任务列表。
  2. 数据映射元素拖动至集成设计器。
  3. 点击设计器上的数据映射任务以打开任务的配置窗格。
  4. 点击打开数据映射编辑器

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

    在本快速入门中,请按照以下步骤使用 responseBody(调用 REST 端点)作为输入来创建映射:

    1. responseBody 信息块从编辑器左侧的变量列表拖动到第一个输入字段。
    2. 点击 responseBody 信息块中的 + 添加函数以查看可用函数的下拉列表。
    3. 您可以应用许多数据映射函数来转换输入变量中的数据。在这种情况下,您可以将载荷转换为 JSON,然后遍历响应数组,以获取电子邮件通知所需的产品名称列表。点击 responseBody 变量上的 + 添加函数符号,以打开可用函数列表。使用以下函数:
      • 选择 TO_JSON()responseBody 字符串转换为 JSON。
      • 再次点击 responseBody 变量信息块上的 + 添加函数符号,以选择并关联 GET_PROPERTY() 函数。此函数将从 JSON 载荷中提取属性。传入 products.name 属性作为此函数的参数。此操作只会返回产品名称列表,而不会包含任何其他产品信息。您的函数应如下所示:
        responseBody(Call REST Endpoint).TO_JSON().GET_PROPERTY(products.name)
      • 如果您需要移除或删除函数,请点击 - 符号。这将移除最近添加的函数。
    4. 点击输出列中的第一个字段,以创建一个新变量来保存转换后的数据的值。填写以下字段:
      • 名称:输入 JSONProdNameList
      • 数据类型JSON
      • 选中用作集成的输出
      • 点击创建以创建变量并关闭窗格。新的 JSONProdNameList 变量将显示在数据映射编辑器左侧的变量列表中。
    5. 数据映射编辑器中,点击 X 以保存映射并关闭编辑器。
    6. 已完成的映射应如下图所示:

      已完成数据映射和变量的图片

  5. 如需添加从调用 REST 端点元素到数据映射元素的边缘连接,请将控制点悬停在调用 REST 端点元素上,然后点击线条并将其拖动到数据映射任务元素上的控制点。边缘表示从调用 REST 端点任务到数据映射任务的控制流。

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

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

  1. 在集成设计器中选择添加任务/触发器 > 任务以显示可用任务列表。

    对于此步骤,请使用发送电子邮件任务。

  2. 发送电子邮件元素拖动至集成设计器。
  3. 点击设计器上的发送电子邮件元素以打开任务的配置窗格。设置以下属性:
    • 收件人:输入您的电子邮件地址:您将使用此电子邮件来确认集成已成功完成。
    • 主题:输入 Email from Apigee Integrations
    • 电子邮件正文:选择之前在数据映射任务中创建的 JSONProdNameList 变量。
    • 其余选项可以保留默认配置。

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

    已完成的配置应与下图一致:

    电子邮件任务配置

  4. 如需添加从数据映射元素到发送电子邮件元素的边缘连接,请将控制点悬停在数据映射元素上,然后点击线条并将其拖动到发送电子邮件任务元素上的控制点。控制点和边缘线条会变为黄色。边缘表示从数据映射任务到发送电子邮件任务的控制流。

测试集成

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

  1. 在集成设计器工具栏中点击发布按钮。发布集成将激活工具栏中的测试按钮。
  2. 点击测试,然后选择 API 触发器
  3. 确认发布和测试对话框中,点击发布和测试

如需详细了解测试,请参阅测试集成

成功完成后,集成会将包含产品名称列表的电子邮件发送到发送电子邮件任务中指定的电子邮件地址。在电子邮件客户端中确认收到电子邮件。

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

["Vintage Typewriter", "Vintage Camera Lens", "Home Barista
Kit", "Terrarium", "Film Camera", "Vintage Record Player", "Metal Camping
Mug", "City Bike", "Air Plant"]

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

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

恭喜!您已成功配置和部署与 Apigee Integration 的集成。

后续步骤