连接器

本页内容针对 Controlled Release (CR) 的产品或特性。 如果您不是 CR 组的成员,如需了解更多信息,请联系您的 客户代表

连接器允许客户将NiCE生态系统之外的外部应用程序链接到他们的工作流程中。 这使组织可以更轻松地将来自前台和后台系统的数据汇集在一起。 这允许平稳的端到端作。 为了支持这一点,NiCE 与其 OEM 合作伙伴 Tray 合作,后者为许多流行的应用程序提供即用型连接器。 如果用户使用 Tray 不支持的应用程序,他们仍然可以使用自定义连接器将其连接到其工作流。 这些连接器支持常见的身份验证方法,并允许用户设置 API 以根据其业务需求获取或更新数据。

能力

  • 带托盘的外部连接器

    • 使用 Tray 的内置连接器集成受支持的第三方应用程序。

  • 定制连接器

    • 支持集成不受支持或专有的应用程序。

    • 支持主要身份验证类型:

      • 无身份验证

      • 不记名令牌

      • OAuth 2.0

      • API 密钥

      • OAuth 1.0 (Mock)/SAML Mock

    • 允许配置自定义 API。

查看和管理连接器

要管理连接器,请执行以下作:

  1. 单击应用程序选择器 应用程序选择器的图标 并选择 Orchestrator

  2. 在左侧导航面板中,单击连接器管理选项卡。

  3. “连接器”页显示所有已配置连接器的列表。 用户可以在以下之间切换:

    • 列表视图:以表格格式显示带有元数据列的连接器。

    • 磁贴视图:将连接器显示为具有关键详细信息的单个卡片。

    使用磁贴视图进行可视化摘要,使用列表视图进行多个连接器的详细比较。

  4. 为每个连接器显示以下关键元数据:

    元数据 说明
    连接器名称 连接器的标识符或名称。
    说明 有关连接器用途的可选说明。
    状态 指示连接器是活动还是不活动。 (如果在已发布的工作流中使用连接器,则状态显示为活动否则、不活动。
    活动工作流程 当前使用连接器的工作流数。
    最后修改 连接器最近更新的时间戳。
  5. 没有活动工作流或缺少说明的连接器可能仍然有效,但当前未使用。 使用搜索栏按名称或描述查找连接器。 如果没有连接器与条件匹配,则会显示一条消息,其中包含插图和以下文本:

    1. 添加新连接器

      您配置的连接器可用于Orchestrator工作流来执行作、链接任务和协调业务。

    2. 提供了两个按钮,允许用户创建新的连接器:

      • + 外部连接器:用于与第三方或外部系统集成。

      • + 自定义 API 连接器:用于使用自定义API终结点定义连接器。

  6. 按照创建新建连接器部分中概述的步骤完成设置。

创建新建连接器

要创建新连接器,请执行以下作:

  1. 单击应用程序选择器 应用程序选择器的图标 并选择 Orchestrator

  2. 在左侧导航面板中,单击连接器管理选项卡。

  3. 单击位于连接器页面右上角的新建连接器按钮。

  4. 单击外部应用程序用于与第三方或外部系统集成。

    1. 在“连接器信息”部分中:

      • 应用程序:从下拉列表中选择要连接到的外部应用程序。 (必填)

      • 连接器名称:输入连接器的唯一名称。 (必填)

      • 连接器描述:简要描述连接器的用途或功能。

    2. 单击 下一步 进入作部分。 在这里,您需要定义连接器将支持的 API 方法。 每个作包括:

      • 方法:选择 HTTP 方法(例如 POST、PUT、DELETE、GET、PATCH)。

      • 操作名称:为操作提供描述性名称(例如,创建客户端记录、检索客户端列表)。

      • 说明:说明作的作用以及它如何与外部应用程序交互。

      • 测试操作:单击测试操作链接以验证API调用并确保其按预期工作。

    3. 定义并测试所有作后,单击 保存连接器 保存配置。 然后,连接器将显示在连接器列表中,并准备好在工作流中使用。

  5. 单击 自定义 API 使用 OpenAPI 规范创建自定义连接器。 在“连接器信息”部分中:

    • 连接器名称:输入连接器的唯一名称。 (必填)

    • 徽标 上传:添加徽标以直观地标识连接器。

    • 连接器描述:简要描述连接器的用途或功能。

  6. 点击 下一页 进入身份验证程序类型部分。 从下拉列表中,为您的 API 选择适当的身份验证方法:

    • 无身份验证:用于开放/公共 API。

    • 不记名令牌:需要令牌字符串。

    • OAuth 2.0:需要:

      • 客户 ID

      • 客户端秘密

      • 授权 URL

      • 令牌 URL

      • 范围

    • API 密钥 :需要:

      • 标题名称

      • API 密钥值

    • OAuth 1.0 (Mock)/SAML Mock:需要:

      • 详细信息字段输入

  7. 单击 下一步 进入作部分。 在这里,您需要定义连接器将支持的一个或多个作:

    1. 单击添加操作

    2. 填写以下字段:

      • 操作名称:API函数的描述性名称。 (必填)

      • 操作方法:选择 HTTP 方法(例如 POST、PUT、DELETE、GET、PATCH)。

      • 操作描述:解释操作的作用。

      • URL:输入端点URL。

      • 标头 (JSON):提供 JSON 格式的标头。

      • 正文 (JSON):以 JSON 格式提供请求正文内容(如果适用)。

    3. 单击添加和测试以验证API调用并确保其按预期运行。 如果结果不满意,请单击 配置操作调整设置。 成功测试作后,单击返回列表。

    4. 单击保存连接器完成设置。

  8. 连接器现在将显示在“连接器”列表中,并且可以在工作流中使用。