查看 Application Integration 支持的连接器

API 触发器

API 触发器用于直接调用集成的执行。

在集成中配置 API 触发器后,您可以执行以下操作:

如需帮助您开始使用 API 触发器,请参阅 API 执行方式教程。本教程将向您展示如何创建与 API 触发器的集成,该触发器会接收用于检索客户信息的 API 请求。

添加 API 触发器

如需向集成添加 API 触发器,请执行以下步骤:
  1. 在 Google Cloud 控制台中,前往 Application Integration 页面。

    转到 Application Integration

  2. 在导航菜单中,点击集成

    系统随即会显示 Integrations List(集成列表)页面,其中列出了 Google Cloud 项目中可用的所有集成。

  3. 选择现有集成,或点击创建集成以创建新的集成。

    要创建新的集成,请执行以下操作:

    1. 创建集成窗格中输入名称和说明。
    2. 选择集成的区域。
    3. 选择用于集成的服务账号。您可以随时在集成工具栏的 Integration summary(集成摘要)窗格中更改或更新集成的服务账号详细信息。
    4. 点击创建

    这将在集成编辑器中打开集成。

  4. 集成编辑器导航栏中,点击触发器以查看可用触发器列表。
  5. 点击 API 触发器元素,并将其放置到设计器中。

配置 API 触发器

如需配置 API 触发器,请点击集成编辑器中的 API 触发器元素。系统会显示 API 触发器配置窗格,其中包含以下字段:

  • 标签:集成中 API 触发器的可见名称。您可以将标签更改为您选择的名称。
  • 备注:您可以向 API 触发器添加备注,以提供有关触发器的更多信息。
  • 触发器 ID:分配给 API 触发器的唯一 ID,格式为 api_trigger/TRIGGER_NAME
  • 输入变量:触发器专用输入变量,可用于为 API 触发器设置请求载荷。
    • 如需向 API 触发器添加或移除现有集成变量,请点击修改,然后从 API 触发器输入变量窗格中选择所需的变量。
    • 如需为所选 API 触发器专门添加新变量,请点击修改,然后从 API 触发器输入变量窗格中选择 + 添加新变量。如需了解支持的数据类型,请参阅支持的变量数据类型
  • 输出变量:触发器专用输出变量,可用于为 API 触发器设置响应载荷。
    • 如需向 API 触发器添加或移除现有集成变量,请点击修改,然后从 API 触发器输出变量窗格中选择所需的变量。
    • 如需为所选 API 触发器专门添加新变量,请点击修改,然后从 API 触发器输出变量窗格中选择 + 添加新变量。如需了解支持的数据类型,请参阅支持的变量数据类型

查看 API 触发器的 OpenAPI 规范

借助 Application Integration,您可以动态生成和查看已发布的集成(已配置一个或多个 API 触发器)的 OpenAPI 规范。如需了解如何查看 OpenAPI 规范,请参阅查看集成的 OpenAPI 规范

使用 API 调用调用 API 触发器

发布了已配置 API 触发器的集成后,您可以使用 projects.locations.integrations.execute 方法从任何应用调用该触发器。此方法会在同步模式下触发执行。

语法

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)" \
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: TIMEOUT_SECONDS" \
    -d '{"trigger_id":"api_trigger/TRIGGER_NAME"}' \
    "https://LOCATION-integrations.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/integrations/-:execute"

请替换以下内容:

  • TIMEOUT_SECONDS:API 调用的超时时间(以秒为单位)。默认超时时间为 120 秒。如需查看预定义的一组请求参数的列表,请参阅系统参数
  • TRIGGER_NAME:集成中的 API 触发器的名称。
  • PROJECT_ID:您的 Google Cloud 项目的 ID。
  • LOCATION:您的 Google Cloud 项目的位置。

示例

以下示例在 demo-project Google Cloud 项目中调用包含 test_API_1 API 触发器的 us-east1 区域中的集成:

curl -X POST \
    -H "authorization: Bearer $(gcloud auth print-access-token)"
    -H "Content-Type: application/json" \
    -H "X-Server-Timeout: 300"
    -d '{"trigger_id":"api_trigger/test_API_1"}' \
    "https://us-east1-integrations.googleapis.com/v1/projects/demo-project/locations/us-central1/integrations/-:execute"

注意事项

使用 API 触发器时,所有输入变量的累计大小不能超过 8 MB。如果大小超过 8 MB,Application Integration 不会运行集成,并且会出现错误。

配额和限制

如需了解配额和限制,请参阅配额和限制

后续步骤