9.2. 添加和管理 API 客户端连接器

Fuse Online 可以创建这些 API 客户端连接器：

  • OpenAPI 文档中的 REST API 客户端连接器。有关 OpenAPI 文档内容的详情，请参考 开发 REST API 客户端连接器。
  • 来自 WSDL 文件的 SOAP API 客户端连接器。

以下主题提供了添加和管理 REST API 客户端连接器的信息和说明：

创建 API 客户端连接器后，有关使用该连接器的详情，请参阅 将 Fuse Online 连接到应用程序和服务，连接到 API 客户端。

9.2.1. 创建 REST API 客户端连接器

上传 OpenAPI 文档，以启用 Fuse Online 创建 REST API 客户端连接器。

前提条件

您有一个 OpenAPI 文档，用于希望 Fuse Online 创建的连接器。

流程

  1. 在 Fuse Online 导航面板中，点 Customizations > API Client Connectors。此处列出了已可用的任何 API 客户端连接器。
  2. 点 Create API Connector。

  3. 在 Create API Connector 页面中，执行以下操作之一：

    • 点击点行框并选择您要上传的 OpenAPI 文件。
    • 选择 Use a URL，并在输入字段中粘贴 OpenAPI 文档的 URL。

  4. 点击 Next。如果有无效或缺失的内容，Fuse Online 将显示有关需要更正内容的信息。选择要上传或点击 Cancel 的不同 OpenAPI 文件，重新调整 OpenAPI 文件，并上传更新的文件。

    如果架构有效，Fuse Online 会显示连接器提供的操作的摘要。这可能包括有关操作定义的错误和警告。

  5. 如果您对概述满意，请单击 Next。

    或者，要重新发布 OpenAPI 文档，请点 Review/Edit 以打开 API Designer 编辑器。根据需要更新架构。有关使用 API 编辑器的详情，请参阅使用 API Designer 设计和开发 API 定义。完成后，保存您的更改，将更新合并到新的 API 客户端连接器中。然后，点 Next 继续创建 API 客户端连接器。

    有时，如果您为 OpenAPI 文档提供 URL，Fuse Online 可以上传它，但无法打开它进行编辑。通常，这由文件主机上的设置所致。要打开该模式进行编辑，Fuse Online 需要文件主机有：

    • https URL。( http URL 不起作用。)
    • 启用 CORS。

  6. 指明 API 的安全要求。Fuse Online 读取 OpenAPI 定义，以确定配置连接器以满足 API 安全要求所需的信息。Fuse Online 可以显示以下任意一种：

    1. 无安全性
    2. HTTP Basic Authorization - to the API 服务使用 HTTP 基本授权，请选择此复选框。之后，当您使用此连接器创建连接时，Fuse Online 会提示您输入用户名和密码。

    3. OAuth 2.0 - Fuse Online 提示您输入：

      1. 授权 URL 是将 Fuse Online 注册为 API 客户端的位置。注册授权 Fuse 在线访问 API。请参阅 将 Fuse 在线连接到应用程序和服务，将 Fuse Online 注册为 REST API 客户端。API 的 OpenAPI 文档或其他文档应该指定这个 URL。如果没有，您必须联系服务提供商来获取此 URL。
      2. OAuth 授权需要访问令牌 URL。同样，API 的 OpenAPI 文档或其他文档应该提供这个 URL。如果没有，您必须联系服务提供商。
    4. API Key - CamelAwsSIf API 服务需要 API 密钥，Fuse Online 会提示输入创建连接器所需的任何信息。提示基于 OpenAPI 定义。例如，您可能需要指定 API 键是否在消息标头或查询参数中。如果 OpenAPI 定义指定了 API 密钥安全性，以及另一个安全类型，请选中复选框来表示您要根据这个连接器在连接中使用 API 密钥安全性。之后，当您使用此连接器创建连接时，Fuse Online 会提示您输入 API 键的值。

  7. 点击 Next。Fuse Online 显示连接器的名称、描述、主机和基本 URL，如 OpenAPI 文档所示。对于从此连接器创建的连接，

    • Fuse Online 连接主机和基础 URL 值，以定义连接的端点。例如，如果主机是 https://example.com，基础 URL 为 /api/v1，则连接端点为 https://example.com/api/v1。
    • Fuse Online 将 OpenAPI 文档应用到数据映射步骤。如果 OpenAPI 文档支持多个模式，Fuse Online 将使用 TLS (HTTPS)模式。
  8. 查看连接器详情，并选择性地上传连接器的图标。如果没有上传图标，Fuse Online 会生成一个图标。您可以稍后上传图标。当 Fuse Online 显示集成流时，它会显示一个连接器的图标，以代表从该连接器创建的连接。

  9. 要覆盖从 OpenAPI 文件获取的值，请编辑您要更改的字段值。

    重要

    在 Fuse Online 创建连接器后 ，您无法更改它。要生效更改，您需要上传更新的 OpenAPI 文档，以便 Fuse Online 能够创建新连接器，或者您可以上传相同的模式，然后在 API 编辑器中编辑它。然后，继续创建新 API 客户端连接器的过程。

  10. 当您满足连接器详情时，点 Save。Fuse Online 在 API 客户端连接器列表中显示新连接器。

后续步骤

有关使用新的 API 连接器的详情，请参阅 将 Fuse 在线连接到应用程序和服务，连接到 API 客户端。

9.2.2. 创建 SOAP API 客户端连接器

上传 WSDL 文件，使 Fuse 在线创建 SOAP API 客户端连接器。

inline 和 external (WSDL URL)都支持具有唯一命名空间的多个模式。

前提条件

您有一个适用于希望 Fuse Online 创建的 SOAP 客户端连接器的 WSDL 文件。

流程

  1. 在 Fuse Online 导航面板中，点 Customizations > API Client Connectors。此处列出了已可用的任何 API 客户端连接器。
  2. 点 Create API Connector。

  3. 在 Create API Connector 页面中，执行以下操作之一：

    • 单击点行框，再选择您要上传的 WSDL (.wsdl)文件。

      请注意，不支持 WSDL 文件中引用的基于磁盘的外部模式，直接导入到连接器（使用文件上传表单）。上传的 WSDL 文件必须使用 内联模式。

    • 选择 Use a URL，并在输入字段中粘贴 WSDL (.wsdl)文件的 URL。

      请注意，基于 URL 的 WSDL 支持托管在 WSDLs 的外部模式。另外，只有基于 URL 的 WSDL 支持基于 WSDL 基础路径中的相对 URL 的外部模式。WSDL URL 必须在 运行时提供给 SOAP 连接器进行解析和验证。因此，请确保在永久 URL 上托管 WSDL 和模式。

  4. 点击 Next。
  5. 在 Specify 服务和端口 页面中，验证服务和端口。
  6. 点击 Next。如果有无效或缺失的内容，Fuse Online 将显示有关需要更正内容的信息。选择要上传或单击 Cancel 的不同 WSDL 文件，重新调整 WSDL 文件，然后上传更新的文件。如果架构有效，Fuse Online 会显示 API 定义摘要（名称和描述）以及导入的元素列表，如操作数量。
  7. 点击 Next。

  8. 指明在调用 WSDL 端点时要使用的安全要求。Fuse Online 读取 API 定义，以确定配置连接器以满足 API 安全要求所需的信息。Fuse Online 可以显示以下任意一种：

    • none （无安全性）
    • HTTP Basic Authorization - to the API 服务使用 HTTP 基本授权，请选择此复选框。之后，当您使用此连接器创建连接时，Fuse Online 会提示您输入用户名和密码。

    • WS-Security Username Token - Fuse Online 提示您输入以下信息：

      1. timestamp - 如果您希望 Fuse Online 向 WS-Security 标头添加 时间戳，请选择这个选项。

      2. Password Type - 选择 Digest、Text 或 None。

        如果您选择 Text 或 Digest ：

        • 指定 您的用户名和密码 。
        • 如果您希望 Fuse Online 将 Nonce 元素添加到 WS-Security Username Token 标头，请选择 Username Token Nonce。
        • 如果您希望 Fuse Online 将 "Created" timestamp 元素添加到 WS-Security Username Token 标头，请选择 Username Token Created。

  9. 点击 Next。Fuse Online 显示连接器的名称、描述和 WSDL 端点地址。

    1. 另外，还可上传连接器的图标。您还可以稍后上传图标。

      注： 对于这个版本，如果没有上传图标，Fuse Online 不会 为您生成一个图标。

      当 Fuse Online 显示集成流时，它会显示一个连接器的图标，以代表从该连接器创建的连接。

    2. 对于 Name，输入您选择的名称，它可帮助您将这个连接与任何其他连接区分开来。
    3. （可选）对于 Description，输入有助于了解此连接的信息。

  10. 查看连接器详情，并覆盖从 WSDL 文件中获取的值，编辑您要更改的字段值。

    重要

    在 Fuse Online 创建连接器后 ，您无法更改它。要生效更改，您需要上传更新的 OpenAPI 文档，以便 Fuse Online 能够创建新连接器，或者您可以上传相同的模式，然后在 API 编辑器中编辑它。然后，继续创建新 API 客户端连接器的过程。

  11. 当您满足连接器详情时，点 Save。Fuse Online 在 API 客户端连接器列表中显示新连接器。

后续步骤

有关使用新的 API 连接器的详情，请参阅 将 Fuse 在线连接到应用程序和服务，连接到 API 客户端。

9.2.3. 通过创建新 API 客户端连接器来更新 API 客户端连接器

当您从中创建 API 客户端连接器的 OpenAPI 文档或 WSDL 文件时，并且希望 API 客户端连接器使用这些更新，您必须创建新的 API 客户端连接器。您无法直接更新 API 客户端连接器。创建新的 API 客户端连接器后，您可以使用它创建新连接，然后编辑使用从 out-of-date 连接器创建的连接的每个集成。

先决条件

准备执行以下操作之一：

  • 对于 REST API 客户端连接器：

    • 上传更新的 OpenAPI 文档。
    • 再次上传过时的模式，并在 API Designer 中更新它。
  • 对于 SOAP API 客户端连接器，上传更新的 WSDL 文件。

流程

  1. 根据更新的 OpenAPI 文档或 WSDL 文件创建一个新的 API 客户端连接器。要方便地区分旧的连接器和新连接器，您可能需要在连接器名称或连接器描述中指定版本号。

    请参阅 开发 REST API 客户端连接器。

  2. 从新连接器创建新连接。同样，您希望能够在从旧连接器创建的连接和从新连接器创建的连接之间轻松区分。连接名称或连接描述中的版本号会很有用。
  3. 通过删除旧连接并添加新连接来编辑使用从旧连接器创建的连接的每个集成。
  4. 发布每个更新的集成。
  5. 建议但不是必需的：删除旧的连接器和旧连接。

9.2.4. 删除 API 客户端连接器

当存在从那个连接器创建的连接时，您无法删除连接器，并在集成中使用此连接。删除 API 客户端连接器后，您无法使用从该连接器创建的连接。

流程

  1. 在左侧面板中，点 Customizations > API Client Connectors。
  2. 在您要删除的连接器名称右侧，点 Delete。
  3. 在确认弹出窗口中，如果您确定要删除连接器，请点击 Delete。