使用您现有的企业系统和第三方服务将您自己的连接和操作添加到自动化工作流。自定义连接器使用 REST API 进行通信,并使用 API 开发工具 Postman 创建标准请求。

使用自定义连接器自动处理内部服务

如果服务支持 REST API 和 JSON 内容类型,您可以在具有自定义连接器的自动化中使用该服务。

使用 Postman 创建标准 REST API

Workspace ONE Intelligence 使用 Postman 标准化系统用于连接内部服务和第三方服务并与之进行交互的 REST API。会使用熟悉的 REST 模板界面创建操作,该界面支持重用保存的操作。Postman 的免费版本具有为自定义连接器创建集合所需的功能。

使用自定义连接器的步骤

  1. 在 Postman 中创建请求集合并导出该集合。
  2. 在 Workspace ONE Intelligence 控制台中添加一个自定义连接,然后导入请求。这些请求现在可用作您在自动化中使用的操作。
  3. 使用导入的操作配置一个自动化工作流,以便在 Workspace ONE Intelligence 中使用自定义连接自动执行任务。

自定义连接器的操作

可以在 Workspace ONE Intelligence 中编辑、删除和测试自定义连接器。您可以在多个连接器中使用操作,因此在对连接器进行编辑或删除操作之前,请考虑相应的后果。

  • 删除 - 要删除整个连接及其所有操作,必须先对其取消授权。取消授权后,任何使用与此连接关联的操作的自动化都将被禁用。在系统删除连接后,将从其他自动化中移除所有关联的操作。您必须编辑并重新启用被禁用的自动化,才能再次运行。此操作不可撤销。
  • 编辑 - 您可以随时编辑连接名称、说明和身份验证类型。要编辑操作请求的详细信息,请编辑 Postman 集合,然后将其重新导入到您的自定义连接中。:如果您错误地编辑身份验证类型并输入凭据,则操作可能无法运行。请谨慎编辑。
  • 测试 - 在 Workspace ONE Intelligence 中测试自定义连接器,以确保 Workspace ONE Intelligence 和您的服务可以进行通信。

注册自定义连接器

要添加自定义连接,请导入您的 Postman 集合。Postman JSON 文件中的请求就是操作。导入集合后,操作便可在自动化工作流中使用。

必备条件

  • 按照“将 Postman 用于自定义连接器”中所述的过程创建集合。
  • 您要连接的服务必须支持 REST API 和 JSON 内容类型。
  • Workspace ONE Intelligence 需要 API 端点的访问权限。如果服务在防火墙后面,请使用 Unified Access Gateway 作为反向代理。
  • 如果使用 OAuth2 进行身份验证,请提供授权详细信息,以便 Workspace ONE Intelligence 可以检索、刷新和访问服务的令牌。
    • OAuth2 令牌 URL
    • 客户端密钥
    • 客户端 ID
    • 授权类型(客户端凭据或密码)

过程

  1. 在 Workspace ONE Intelligence 中,转到集成 > 自动化连接器,然后选择添加自定义连接器
  2. 对于连接名称,输入连接的可识别名称。
  3. 对于基本 URL,输入服务的 URL,以便 Workspace ONE Intelligence 可以进行身份验证。服务的 URL 和自定义连接的 URL 必须匹配。
  4. 对于身份验证类型,选择用于访问服务的身份验证类型。Workspace ONE Intelligence 将使用此设置替代集合中的 Postman 身份验证标头。如果您的服务使用唯一的基于标头的身份验证类型,请将标头添加到 Postman 集合中的所有请求并配置基本 URL。在此方案中,Workspace ONE Intelligence 使用在 Postman 集合中配置的标头。基于标头的身份验证类型示例使用 API 密钥或令牌。
    • 基本身份验证 - 向 Workspace ONE Intelligence 授予访问权限,输入凭据。
    • OAuth2 身份验证 - 输入详细信息,以便 Workspace ONE Intelligence 可以检索、刷新和访问服务的令牌。
    • 无身份验证 - 如果不希望 Workspace ONE Intelligence 替代身份验证标头,请选择此菜单项。
  5. 要导入 Postman JSON 文件,请使用 UI 中间的从您的计算机中选择链接。UI 会显示集合及其请求。这些 Postman 请求现在可用作自动化的操作。
  6. 从导入的操作列表中,您可以测试、编辑和删除操作。
    • 删除 - 如果要删除的操作在其他自动化中使用,系统将禁用这些自动化并移除该操作。您必须编辑和重新启用这些自动化,才能使其继续运行。删除不可撤销。
    • 编辑 - 您可以编辑操作的名称和说明。系统会从导入的 Postman JSON 中收集名称和说明。要编辑操作请求的详细信息,请编辑 Postman 集合,然后将其重新导入到您的自定义连接中。
    • 测试 - 使用“测试”菜单项可确保连接正常工作。系统会测试在 Postman 集合中配置的请求。

将 Postman 用于自定义连接器

使用 Postman 应用可以为自定义连接器创建标准 REST API。此内容提供了一个常规工作流,用于创建 Postman 集合并以 JSON 文件形式导出这些集合。

该应用的免费版本包含创建和导出请求集合以实现自动化的功能。

本主题概括介绍了创建和导出集合时必须执行的操作。仅供参考。有关如何配置 Postman 产品的最新说明,请参阅 Postman 学习中心

https://www.getpostman.com 获取 Postman 应用。

过程

  1. 添加集合。
  2. 在集合中添加和配置请求。
    • 这些请求中提供的名称和说明将用于 Workspace ONE Intelligence 中的工作流操作。您可以稍后在 Workspace ONE Intelligence 中更改名称和说明。以下示例为 Postman 请求中的一个条目及其在 Workspace ONE Intelligence 的自动化中如何呈现为一个操作。Postman 示例,代码 Postman 示例,UI
    • 可以考虑添加 Content-Type: application/json 作为标头。如果未将标头添加为内容类型 JSON,则 API 会默认为 XML,而 XML 不适用于自定义连接器。
    • 将 API 所需的任何自定义标头添加到 Postman 集合中的所有请求。自定义标头的示例都是唯一的基于标头的身份验证类型,如 API 密钥或令牌。Workspace ONE Intelligence 会保留除身份验证标头以外的所有标头。并使用自定义集合中身份验证类型的配置覆盖身份验证标头。如果 Workspace ONE Intelligence 替代身份验证标头,则系统仍会向您发送唯一的基于标头的身份验证供您使用,因为您已将其添加到其他请求。
  3. 发送请求以对其进行验证。验证会生成响应。
  4. 将响应另存为文档示例。Open API 协议需要执行此步骤。
  5. 保存请求。
  6. 根据需要添加更多请求。
  7. 将集合导出为集合 2.1
check-circle-line exclamation-circle-line close-line
Scroll to top icon