Integration Hub

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

Integration Hub 提供处理 CXone 与第三方身份验证和 Web 服务集成的标准化方法。Web 服务可以是应用程序、平台或系统。

Integration Hub 是您可以在 CXone 中使用 REST API 调用的方式之一。使用 Integration Hub 的好处是您可以添加连接并在多个位置使用它。其他方法需要在您每次使用时建立连接。

此外,Integration Hub 提供增强的安全性,包括 MTLS 和秘密。作为秘密添加的变量已加密,无法直接访问。

连接和连接模板

连接定义 API 请求的详细信息、身份验证详细信息,以及您要在 CXone 中使用的变量。连接不必包含所有类型的连接信息。它可以保存受支持信息类型的任意组合。

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

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

Integration Hub 有两种类型的模板:NICE 拥有的系统模板,以及您自己创建的模板。系统模板自带 Integration Hub,无法删除。它们包括:

  • NICE CXone 开发门户:与 API 开发者门户 中提供的端点集成,以减少对 Studio Framework 操作的依赖。它使用 OAuth 2.0 身份验证。为确定身份验证,它使用发现 URL。它不支持客户端证书。

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

模板可在 Integration Hub 的连接库中获得。连接列在 Integration Hub 中的“我的连接”下。您最多可以创建 50 个连接。模板数量没有限制。

请求

请求是 API 调用。它们指定用于连接到 Web 服务的以下信息:

  • URL:您要连接到的资源的位置。
  • 方法(动词):您希望请求执行的操作,例如检索数据或创建新记录。Integration Hub支持以下动词:GET、PUT、POST、DELETE、TRACE、PATCH、HEAD、OPTIONS。在用于创建连接的模板中定义可在连接中使用的动词。
  • 标头:请求的一部分,其包含有关请求的其他信息。这可以包括语言、凭据等。
  • 查询参数:一种通过 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

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

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