Integration Hub

Integration Hub 提供了一个集中处理与外部系统和服务集成的地方。 它允许您创建标准化的 RESTAPI关闭 应用程序编程接口。 允许通过将您的 CXone Mpower 系统与其他软件连接来实现特定功能的自动化。 连接，您可以在多个 Studio 脚本中使用这些连接。 这样就避免了每次想通过 API 与外部通信时都需要重复构建相同的请求。 相反，你可以在 Integration Hub中构建一次请求，然后在任何需要的地方重复使用它。 这简化并加快了脚本编写过程。

Integration Hub 还能让您的集成更加安全。 它会对 API 凭据进行加密，因此每次使用时，这些凭据都不会在脚本中暴露出来。 Studio 脚本以纯文本形式存储，因此您无法将重要的凭据（例如用于 API 请求的令牌）直接安全地存储在脚本中的变量中。 Integration Hub 允许您快速向脚本添加身份验证请求，然后在后续 API 调用中安全地使用检索到的凭据。 您还可以向 API 请求添加 mTLS 证书。

Integration Hub 是自动化和人工智能 应用程序 的一部分 CXone Mpower中。 如果您拥有 启动自动化和 AI 权限，则可以从 应用程序 在新窗口中打开 CXone Mpower 并单击 Integration Hub。

Integration Hub，左侧显示“我的连接”列表，右侧显示连接库。

连接

连接定义了与外部服务集成的详细信息，例如 API 请求、身份验证流程和变量。 例如，您可以为 Salesforce创建一个连接模板。 这将定义与 Salesforce连接所需的基本细节，例如身份验证类型和支持的方法。 通过此模板，您可以创建一个连接，从而可以填写模板中的特定详细信息，以及更具体的详细信息，例如您要向 Salesforce发出的特定 API 请求。

连接模板

添加到 Integration Hub 的每个连接都是基于连接模板创建的。 模板定义适用于将使用该模板建立的所有连接的基本信息。 这包括：

  • 您正在连接到的 Web 服务的名称。
  • 集成方法。 当前，REST API 是唯一受支持的方法。
  • 身份验证的类型（如果有）。 当前，您可以选择 OAuth 2.0 或不进行身份验证。
  • 用于身份验证的自定义标头（如果需要）。
  • 可供基于模板发出的请求使用的动词。 动词是可以对连接的 Web 服务执行的作，例如检索数据 （GET） 或创建记录 （POST）。

连接不必包含所有类型的连接信息。 它可以保存受支持信息类型的任意组合。

所有连接模板都可以在连接库 Integration Hub中找到。 您可以在 Studio 脚本中使用的模板列在 Integration Hub的“我的连接”下。 您最多可以创建 50 个连接（在“我的连接”列表中）。 连接库中的模板数量没有限制。

所有模板均不可修改。 但是，可删除您的自定义模板。 如果稍后需要更改自定义模板中的某些内容，则可删除该模板并创建一个新模板。 连接本身可以修改。 删除自定义模板不会影响使用该模板创建的连接。

系统模板

Integration Hub 有两种类型的模板：NiCE 拥有的系统模板，以及您自己创建的模板。 系统模板自带 Integration Hub，无法删除。 目前，Integration Hub包含一个系统模板：

  • CXone Mpower开发人员门户：与CXone Mpower开发人员门户 上记录的API端点集成。 这是为了减少对Studio 框架作的依赖。 它使用 OAuth 2.0 身份验证。 为确定身份验证，它使用发现 URL。 它不支持客户端证书。

请求

请求是 API 调用。 对于“我的连接”列表中的每个连接，您可以添加要与特定外部服务一起使用的请求。 这些请求指定了以下信息，这些信息用于连接到 Web 服务：

  • URL：您要连接到的资源的位置。
  • 方法（动词）：您希望请求执行的操作，例如检索数据或创建新记录。 Integration Hub支持以下动词：GET、PUT、POST、DELETE、TRACE、PATCH、HEAD、OPTIONS。 在用于创建连接的模板中定义可在连接中使用的动词。
  • 标头：请求的一部分，其包含有关请求的其他信息。 这可以包括语言、凭据等。
  • 查询参数：一种在端点URL中使用API请求传递信息的方法。 它们被配置为键值对。 它们可用于筛选、排序、自定义或控制响应中返回的数据。
  • 正文：请求的内容。 格式取决于您正在连接到的 API 的要求。 正文的媒体类型必须与您正在连接到的资源期望的媒体类型相匹配。 其也称为 MIME 类型或内容类型。 这些是支持的选项和关联的内容标题： 
    • ApplicationJson：application/json
    • ApplicationJsonPatch：application/json-patch+json
    • FormURLEncoded：application/x-www-form-urlencoded
    • TextHtml：text/html
    • TextPlain：text/plain
    • TextXml: text/xml
    • Sigv4: application/x-amz-json-1.1

每个 Integration Hub 连接最多可以有 50 个请求。 对于一次可有多少个请求处于活动状态没有限制。

CXone Mpower 对响应大小有 32 KB 限制。 使用查询参数来筛选返回的数据。 这可帮助您保持在该限制以下。

手动和 Studio 请求

对于连接中的请求，Integration Hub 支持两个选项：

  • 手动：使用“添加请求”页面上的选项在 Integration Hub 中构建手动请求。 您可以在其中使用秘密。 手动请求通常用于数据不变的情况。 它们可以直接从 Integration Hub 执行，无需使用 Studio 脚本。 它们也可以在 Studio 脚本中执行。

  • Studio：在某些情况下，API 请求无法在 Integration Hub 中构建为手动请求。 例如，需要路径参数、变量替换或连接到 SOAP Web 服务的请求必须在 Studio 脚本中构建。 但是，您可能希望在 Integration Hub 连接中跟踪这些请求。 Studio 请求选项可使您执行此操作。 Studio 请求与该连接具有的所有手动请求一同显示在连接的“请求”选项卡上。

变量

Integration Hub 可使您将值对存储为变量。 默认情况下变量未加密。 但是，您可以通过将变量变成秘密来对其进行加密。 将变量标记为秘密可提高敏感信息（例如密码或密钥）的安全性。

变量可以在您创建它们所在的连接中使用。 如果您在 Studio 脚本中执行连接或身份验证请求，则可以在脚本中使用来自该连接的变量。

机密在加密数据库中静态加密。 Integration Hub 使用高级加密标准 (AES) 来加密数据。 解密数据的唯一时间是在执行时。

Integration Hub Studio 操作

当您想要在 Studio 脚本中使用身份验证或发出请求时，使用以下 Studio 操作：

关于 Integration Hub Studio 操作的关键事实

  • 它们需要 Integration Hub。 如果在 CXone Mpower 系统中未启用 Integration Hub，则这些操作不起作用。
  • 您可在脚本中包含每个操作的多个实例。
  • 您可以使用变量替换来执行不同的请求，或者在单个脚本中使用来自多个连接的身份验证。
  • 正如在 CXone Mpower 中进行 API 调用的其他方法一样，需要通过额外的脚本编写来接收来自已连接 Web 服务的响应并对其进行适当的处​​理。
  • CONNECTAUTH 不允许进行任何自定义。 它执行如 Integration Hub 的连接中定义的身份验证请求。

断路器

Integration Hub 有一个内置断路器。 这是针对失败的 API 调用的预防性故障保护。 如果断路器检测到调用反复失败，它会激活并限制 API 调用。 调用失败的最常见原因是临时服务器错误（500 错误）。 限制（或暂停）调用使服务器有时间恢复并正常运行。

以下是断路器的主要特性：

  • 如果 30 秒内超过 50% 的 API 调用失败，则断路器会激活。

  • 要触发断路器，Integration Hub 必须在 30 秒的时间内尝试对单个 API 进行超过 100 次调用。

  • 断路器激活 30 秒。

  • 可在 Studio trace 日志中访问失败原因（在 _err 变量中捕获）。

审核历史记录

Integration Hub中的每个连接都有一个更改日志。 每当创建或更新连接时，都会记录以下详细信息：

  • Date：进行更改的日期。

  • 修改者：谁进行了更改。

  • 配置文件名称：连接的名称。

  • 作：发生了什么，例如连接是创建还是修改了。

用户将能够从连接设置中的新审核按钮访问此日志。