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


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

  • 来自 OpenAPI 文档的 REST API 客户端连接器。有关 OpenAPI 文档内容的信息,请参阅 开发 REST API 客户端连接器
  • 来自 WSDL 文件的 SOAP API 客户端连接器。

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

创建 API 客户端连接器后,以了解有关使用该连接器的详情,请参阅将 Fuse Online 连接到 Applications and Services,连接到 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 就显示有关需要更正的内容的信息。选择不同的 OpenAPI 文件来上传或单击 Cancel,然后修改 OpenAPI 文件并上传更新的文件。

    如果该模式有效,Fuse Online 会显示连接器提供的操作摘要。这可能包括与操作定义相关的错误和警告。

  5. 如果您对摘要满意,请单击 Next

    或者,若要调整 OpenAPI 文档,请点击 Review/Edit 以打开 API Designer 编辑器。根据需要更新 schema。有关使用 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 -用于 API 服务使用 HTTP 基本授权,选择此复选框。之后,当您使用这个连接器创建连接时,Fuse Online 会提示您输入用户名和密码。
    3. OAuth 2.0 - Fuse 在线提示您输入:

      1. 授权 URL 是将 Fuse Online 注册为 API 客户端的位置。注册会授权 Fuse Online 访问 API。请参阅将 Fuse Online 连接到 Applications and Services,将 Fuse Online 注册为 REST API 客户端。API 的 OpenAPI 文档或其他文档应该指定这个 URL。如果没有,您必须联系服务供应商来获取这个 URL。
      2. OAuth 授权需要访问令牌 URL。同样,API 的 OpenAPI 文档或其他文档应该提供这个 URL。如果没有,您必须联系服务供应商。
    4. API 密钥 - 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 Client Connectors 列表中显示新的连接器。

后续步骤

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

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

上传 WSDL 文件,以启用 Fuse Online 以创建 SOAP API 客户端连接器。

内联和外部(WSDL URL)支持具有唯一命名空间的多个模式。

前提条件

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

流程

  1. 在 Fuse Online 导航面板中,点击 Customizations > API Client Connectors。下面列出了所有已可用的 API 客户端连接器。
  2. Create API Connector
  3. Create API Connector 页面中,进行以下操作之一:

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

      请注意,不支持在 WSDL 文件中引用基于磁盘的外部模式,该文件直接导入到连接器(使用 File Upload 表单)。上传的 WSDL 文件 必须使用 内联架构。

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

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

  4. 点击 Next
  5. Specify service and port 页面上,验证服务和端口。
  6. 点击 Next。如果内容无效或缺失,Fuse Online 就显示有关需要更正的内容的信息。选择其他 WSDL 文件以上传或单击 Cancel,然后调整 WSDL 文件,然后上传更新的文件。如果 schema 有效,Fuse Online 会显示 API 定义(名称和描述)的摘要以及导入的元素列表,如操作数量。
  7. 点击 Next
  8. 指明调用 WSDL 端点时要使用的安全要求。Fuse Online 读取 API 定义,以确定配置连接器所需的信息,以满足 API 的安全要求。Fuse Online 可显示以下任意一种:

    • (无安全性)
    • HTTP Basic Authorization -用于 API 服务使用 HTTP 基本授权,选择此复选框。之后,当您使用这个连接器创建连接时,Fuse Online 会提示您输入用户名和密码。
    • WS-Security Username Token - Fuse Online 提示您输入以下信息:

      1. 时间戳 - 如果您希望 Fuse Online 为 WS-Security 标头添加时间戳,请选择这个选项。
      2. 密码类型 - 选择 Digest 、文本None

        如果您选择 TextDigest:

        • 指定 您的用户名和密码
        • 如果您希望 Fuse Online 添加 Nonce 元素到 WS-Security Username Token 标头,请选择 Username Token Nonce
        • 如果您希望 Fuse Online 将"Created"时间戳元素添加到 WS-Security Username Token 标头,请选择 Username Token Created
  9. 点击 Next。Fuse Online 显示连接器的名称、描述和 WSDL 端点地址。

    1. (可选)上传连接器的图标。您还可以稍后上传一个图标。

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

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

    2. 对于" 名称 ",输入您选择的名称,可帮助您将此连接与任何其他连接区分开来。
    3. 另外,对于 Description,输入有助于了解这个连接的信息。
  10. 查看连接器详情并覆盖从 WSDL 文件获取的值,编辑您要更改的字段值。

    重要

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

  11. 当您满足连接器详情时,点 Save。Fuse Online 在 API Client Connectors 列表中显示新的连接器。

后续步骤

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

当对创建 API 客户端连接器的 OpenAPI 文档或 WSDL 文件进行更新时,并且您希望 API 客户端连接器使用这些更新,您必须创建一个新的 API 客户端连接器。您不能直接更新 API 客户端连接器。创建新的 API 客户端连接器后,您可以使用它创建新连接,然后编辑使用从过时连接器中创建的连接的每个集成。

先决条件

准备进行以下操作之一:

  • 对于 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
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2026 Red Hat
返回顶部