管理连接

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

Integration Hub 连接可使您设置与第三方 Web 服务的集成以便在 CXone 中使用。

创建连接模板

连接模板定义有关集成的基本信息。模板用于创建连接，您可以在其中配置特定请求和其他信息。

连接模板创建后无法修改。如果您需要更改任何详细信息（包括标题），则必须创建新模板。

Integration Hub 中“添加模板”页面的屏幕截图。
  1. 在 CXone 中单击应用程序选择器 并选择自动化与 AI > Integration Hub。
  2. 单击添加模板。
  3. 在“详细信息”选项卡上，输入该模板的名称。
  4. 输入您要连接到的应用程序的名称。这可以是应用程序、平台或 Web 服务。
  5. 选择 REST 作为集成方法。当前，REST 是唯一支持的方法。

  6. 选择身份验证类型的选项。

    选项 详细信息
    OAuth 2.0 如果您希望该模板包含 OAuth 2.0 身份验证，则选择此选项。当前，这是唯一支持的身份验证类型。
    无身份验证 如果您不希望模板包含身份验证，则选择此选项。
  7. 输入该模板的描述。其他用户从连接库中选择该模板时可看到该描述。
  8. 通过拖放图像或单击或浏览文件来附加图标。对于该模板，此图标显示在从该模板创建的所有连接的连接库中。
  9. 在“配置”选项卡上，选择您希望可与该模板一起使用的方法（动词）。并非所有 Web 服务都支持所有 REST 动词。
  10. 要为该模板定义自定义身份验证标头，则单击添加自定义标头。仅当您为该模板启用了身份验证时，此选项才可用。要定义标头：
    1. 在显示的字段中输入标头名称。
    2. 单击添加自定义标头可添加更多自定义标头。
    3. 选择必填？- 对于必须在从该模板创建的连接中使用的任何标头。
    4. 单击 X 可删除标头。
  11. 仔细检查所有设置。保存模板后您无法对其进行编辑。
  12. 执行以下操作之一：
    • 单击保存可将模板添加到连接库。
    • 单击保存 + 我的连接可将模板添加到连接库并从中创建连接。创建连接后，您可以通过添加身份验证详细信息、变量或请求对其进行配置。您的请求可以包括任何或所有这些配置。

从模板创建连接

连接可使您创建请求并添加身份验证详细信息。连接显示在 Integration Hub 中的“我的连接”下。

您可以从连接模板创建连接。连接库显示 CXone 系统 中存在的所有连接模板。如果没有与您需要执行的操作相匹配的模板，您可以创建一个。

  1. 在 CXone 中单击应用程序选择器 并选择自动化与 AI > Integration Hub。

  2. 在连接库中查找模板。该库位于页面右侧。如果您正在查看某个连接或模板，则单击页面右上角的 X。这会将其关闭，以便您能够看到连接库。

  3. 单击模板属性页面上的我的连接，以便基于该模板创建一个连接。

  4. 如果您正在使用 mTLS 自签名证书，请填写以下字段：

    • 客户证书
    • 客户端私有密钥
    • 密钥口令

    仅当您使用 OAuth 2.0 作为身份验证类型时，这些字段才会显示。您应同时输入客户端证书和客户端私有密钥。如果您的客户端私有密钥已加密，则必须输入密钥口令。仅当您的身份验证 URL 采用 HTTPS 时，mTLS 证书才有效。保存此连接后将验证这些字段。您可以在秘密选项卡中引用这些字段。

  5. 输入连接的名称，然后单击保存。

  6. 单击页面左侧列表中的新连接。

  7. 在“配置”选项卡上，配置超时（单位为毫秒）。此超时适用于在该连接中配置的所有请求，包括身份验证。

  8. 根据需要配置身份验证和请求。您的连接可以包括其中之一，或这二者。

  9. 如果您有想要加密以便在该连接中使用的信息，则配置变量。

配置身份验证详细信息

您可以在您连接中的“身份验证”选项卡上配置身份验证详细信息。仅当在用于此连接的模板中启用身份验证时，才显示此选项卡。

  1. 在 CXone 中单击应用程序选择器 并选择自动化与 AI > Integration Hub。

  2. 从页面左侧的“我的连接”中，单击您要使用的连接。

  3. 在“身份验证”选项卡上，输入用于身份验证请求的 URL。该 URL 不能是动态的，但您可以在其中引用秘密。

  4. 选择在身份验证请求中使用的 REST 方法（动词）。可用动词由用于此连接的模板定义。

  5. 在“标头”下，在每个字段中输入相应值。带星号 (*) 的字段为必填字段。这些字段是在用于此连接的模板中定义的。

  6. 要将自定义标头添加到此连接：

    1. 单击添加自定义标头。

    2. 输入标头名称和标头值。

  7. 要将查询参数添加到身份验证请求：
    1. 单击添加查询参数。
    2. 对于您添加的每个查询参数，输入查询参数名称和查询参数值。

  8. 选择媒体类型并输入正文内容。媒体类型影响正文内容的格式。它应与您正在使用的授权服务器所需的类型匹配。

    选项 详细信息

    ApplicationJson

    正文内容必须采用 JSON 格式。
    ApplicationJsonPatch 正文内容必须采用 JSON Patch 格式。
    FormURLEncoded

    正文内容必须采用键值对形式。这种媒体类型使用常见的 URL 符号发送请求。

    单击 +添加表单参数，然后输入表单参数名称和表单参数值。
    TextHtml 正文内容必须采用 HTML 格式。
    TextPlain 正文内容必须采用纯文本形式。
    TextXml 正文内容必须采用 XML 格式。

  9. 单击保存。

将变量添加到连接

Integration Hub 变量可使您在连接中共享某些信息。您可以确定该信息是否已加密。当使用敏感信息（例如 Studio 脚本中的密码）时，已加密变量或秘密可提供额外的安全层。

创建变量时，您可以随时将其转换为秘密。一旦变量成为秘密并且连接器已保存，您便无法将秘密转回变量。

秘密不可逆。当您远离秘密值字段单击时，内容将被加密并被替换为屏蔽星号 (*)。屏蔽后，无法检索您在该字段中输入的值。

  1. 在 CXone 中单击应用程序选择器 并选择自动化与 AI > Integration Hub。

  2. 从页面左侧的“我的连接”中，单击您要使用的连接。

  3. 在“变量”选项卡上，单击 + 添加变量。

  4. 输入标识变量包含的内容的变量名称。名称可包含空格或特殊字符。

  5. 输入变量值。这是变量的值以及当您将变量变成秘密时将被加密的信息。在将其启用为秘密之前，请验证该信息是否正确。

  6. 要加密变量，则启用秘密开关。

  7. 要从连接中删除变量，请单击其右侧的 X。

  8. 单击保存。

在连接中使用变量

您可以在手动或 Studio 脚本请求中使用变量。您可以在标题、查询参数和正文内容中使用它们。

在身份验证详细信息或手动请求中使用变量

  1. 在 CXone 中单击应用程序选择器 并选择自动化与 AI > Integration Hub。

  2. 从页面左侧的“我的连接”中，单击您要使用的连接。

  3. 单击要使用变量的选项卡。可在身份验证和请求选项卡上使用变量。

  4. 按照以下准则在您想要设置变量值的位置输入变量：

    • 将名称括在双括号中。例如，[[ variableName ]]。
    • 使用与在“变量”选项卡上变量名称字段中输入的名称完全相同的名称。
    • 变量只能在创建它们所在的连接中使用。

在 Studio 请求中使用变量

要在 Studio 脚本中使用变量，该脚本必须具有 CONNECTAuth 或 CONNECTREQUEST 操作。此操作必须将该脚本与包含变量的连接进行关联。

  1. 在 Studio 中，打开要在其中使用变量的脚本。

  2. 双击您想要向其添加变量的 Snippet 操作。

  3. 在 Snippet 编辑器窗口中，按照以下准则在您想要设置变量值的位置输入变量：

    • 将名称括在双括号中。例如，[[ variableName ]]。
    • 使用与在“变量”选项卡上变量名称字段中输入的名称完全相同的名称。
    • 将括号和变量名称用双引号 (“”)引起来。例如，"[[ variableName ]]"。如果变量是字符串（例如 URL）的一部分，则必须将整个字符串（而不仅仅是变量）用双引号引起来。例如，"[[ variableName ]]/location/anotherlocation/"。
    • 变量只能在创建它们所在的连接中使用。必须在脚本中使用 CONNECTAuth 或 CONNECTREQUEST 操作指定连接。

    示例：

    • ASSIGN requestPayload.body = "[[client_id]]"

    • ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS"

创建手动请求

请求是您从集成所连接到的 Web 服务获取所需信息的方式。您可以在 Studio 脚本中使用手动请求或从 Integration Hub 执行它们。

如果您的请求需要路径参数，或者在 URL、标头或参数中需要变量替换，则必须创建一个 Studio 请求。手动请求不支持这些选项。

  1. 在 CXone 中单击应用程序选择器 并选择自动化与 AI > Integration Hub。

  2. 从页面左侧的“我的连接”中，单击您要使用的连接。

  3. 在“请求”选项卡上，单击添加请求。

  4. 输入请求名称。

  5. 选择手动作为触发器。

  6. 输入此请求的 URL。

  7. 单击此请求的方法（动词）。

  8. 在“标头”下，添加您请求所需的任何标头：

    1. 单击添加标头。

    2. 输入标头名称和标头值。

  9. 在“查询参数”下，添加您请求所需的任何查询参数：
    1. 单击添加查询参数。
    2. 输入查询参数名称和查询参数值。

  10. 选择媒体类型并输入正文内容。媒体类型影响正文内容的格式。它应与您正在连接到的 Web 服务所需的类型匹配。

    选项 详细信息

    ApplicationJson

    正文内容必须采用 JSON 格式，并以 application/json 作为内容标题。
    ApplicationJsonPatch 正文内容必须采用 JSON Patch 格式，并以 application/json-patch+json 作为内容标题。
    FormURLEncoded

    正文内容必须采用键/值对形式，并以 application/x-www-form-urlencoded 作为内容标题。这种媒体类型使用常见的 URL 符号发送请求。

    单击 +添加表单参数，然后输入表单参数名称和表单参数值。
    TextHtml 正文内容必须采用 HTML 格式，并以 text/html 作为内容标题。
    TextPlain 正文内容必须采用纯文本形式，并以 text/plain 作为内容标题。
    TextXml 正文内容必须采用 XML 格式，并以 text/xml 作为内容标题。
  11. 如果您想更改此请求的活动状态，请单击页面顶部的活动。文本更改为不活动。
  12. 单击确认。
  13. 在“请求”选项卡上，对于您刚刚添加的请求，单击测试。Integration Hub 尝试此请求。将显示一个窗口，其中显示测试结果。
  14. 单击编辑并对该请求进行更改，或者单击保存。

创建 Studio 请求

当您有无法在 Integration Hub 中创建的 API 请求，但您想要能够将 Integration Hub 用于身份验证和秘密时，Studio 请求会很有帮助。

  1. 在 CXone 中单击应用程序选择器 并选择自动化与 AI > Integration Hub。

  2. 从页面左侧的“我的连接”中，单击您要使用的连接。

  3. 在“请求”选项卡上，单击添加请求。

  4. 输入请求名称。

  5. 选择 Studio 作为触发器。

  6. 如果您想使用示例在脚本中构建 JSON，请从“添加请求”页面选择并复制示例请求有效负载。

  7. 单击确认。

    无法从 Integration Hub 测试 Studio 请求。您必须使用跟踪来运行脚本，才能在 Studio 中测试它们。

  8. 单击保存。
  9. 启动 Studio 并登录。
  10. 打开一个现有脚本或创建一个新脚本。
  11. 将 Snippet 操作添加到脚本中，然后双击它，以打开 Snippet 编辑器窗口。

  12. 在 Snippet 编辑器窗口中构建动态对象，然后将其转换为 JSON。您创建的对象必须包含保存请求所需标头、查询参数和正文内容的成员。

    创建对象时，请使用您在先前步骤中从 Integration Hub 复制的示例有效负载作为指南。示例有效负载为：

    {
 "URL": "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS",
 "HTTPMETHOD": "POST",
 "HEADERS": {
	"CONTENT-TYPE": "APPLICATION/JSON",
	"AUTHORIZATION": "BEARER[[BEARERTOKEN]]"
	},
 "QUERYPARAMETERS": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456"
	},
 "BODY": {
	"ANI": "[[ANI]]",
	"ACCOUNTID": "123456",
	"ACCOUNTNAME": "TESTACCOUNT"
	}
}

    使用示例有效负载作为指导创建的动态对象是：

    DYNAMIC requestPayload 
ASSIGN requestPayload.URL = "[[INSTANCEURI]]/INCONTACTAPI/SERBICES/V26.0/AGENTS"
ASSIGN requestPayload.HTTPMETHOD = "POST"
ASSIGN requestPayload.HEADERS.CONTENTHYPHENPLACEHOLDERTYPE = "APPLICATION/JSON"
ASSIGN requestPayload.HEADERS.AUTHORIZATION = "BEARER[[BEARERTOKEN]]"
ASSIGN requestPayload.QUERYPARAMETERS.ANI = "[[ANI]]"
ASSIGN requestPayload.QUERYPARAMETERS.ACCOUNTID = "123456"
ASSIGN requestPayload.BODY.ANI = "[[ANI]]"
ASSIGN requestPayload.BODY.ACCOUNTID = "123456"
ASSIGN requestPayload.BODY.ACCOUNTNAME = "TESTACCOUNT"
ASSIGN requestPayloadJSON = "{requestPayload.asjson()}"
ASSIGN requestPayloadJSON = "{requestPayloadJSON.replace("HYPHENPLACEHOLDER", "-")}"

    上例的最后一行使用 replace() 函数将连字符 (-) 插入到 CONTENT-TYPE 键名称中。在 Studio 中，变量名称不能包含连字符等特殊字符，因此使用此方法作为规避方法。

  13. 配置脚本以使用请求。

更改请求的状态

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

  1. 在 CXone 中单击应用程序选择器 并选择自动化与 AI > Integration Hub。

  2. 从页面左侧的“我的连接”中，单击您要使用的连接。

  3. 在“请求”选项卡上，单击您要处理的请求。

  4. 单击页面顶部的不活动或活动以更改状态。