管理連接

本頁面中的檔案適用於受控發布 (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 如果您希望範本包含OAuth2.0 驗證，請選擇此選項。目前，這是唯一支援的驗證類型。
    無驗證 如果您不希望範本包含驗證，請選擇此選項。
  7. 輸入範本的描述。其他使用者從連接庫中選擇此範本時可以看到它。
  8. 透過拖放圖像或點擊瀏覽檔案來附加圖示。對於此範本，此圖示會顯示在連接庫中，並且會在「我的連接」下顯示從此範本建立的所有連接。
  9. 在「配置」標籤上，選擇您希望與此範本一起使用的方法（動詞）。並非所有網路服務都支援所有 REST 動詞。
  10. 若要為此範本定義自訂驗證標頭，請點擊新增自訂標頭。僅當您為範本啟用驗證時，此選項才可用。要定義標頭：
    1. 在出現的欄位中輸入標頭名稱。
    2. 點擊新增自訂標頭新增更多自訂標頭。
    3. 為以下標頭選擇需要？：從此範本建立的連接中必須使用的任何標頭。
    4. 點擊X可刪除標頭。
  11. 仔細檢查所有設定。儲存範本後您將無法對其進行編輯。
  12. 執行下列操作之一：
    • 點擊儲存將範本加入連接庫。
    • 點擊儲存 + 我的連接將範本新增至連接庫並從中建立連接。建立連接後，您可以透過新增驗證詳細資訊、秘密或請求。您的請求可以包括任何或所有這些配置。

從範本中建立連接

連接允許您建立請求並新增驗證詳細資訊。連結出現在Integration Hub中的「我的連結」下。

您可以從連接範本建立連接。連接庫顯示CXone系統中存在的所有連接範本。如果沒有與您需要執行的操作相符的範本，您可以建立一個。

  1. 在 CXone 中，點擊應用程式選擇器 並選擇自動化與 AI > Integration Hub。

  2. 在連接庫中找到範本。庫位於頁面的右側。如果您正在查看連接或範本，請點擊頁面右上角的 X。這將關閉頁面，以便您可以看到連接庫。

  3. 點擊範本屬性頁面上的我的連接以基於範本建立連接。

  4. 如果您使用 mTLS 自我簽署憑證，請填寫以下欄位：

    • 客戶憑證
    • 用戶端私密金鑰
    • 金鑰口令

    只有當您使用 OAuth2.0 作為驗證類型時，這些欄位才會出現。您應同時輸入用戶端憑證和用戶端私密金鑰。如果您的用戶端私密金鑰已加密，則您必須輸入金鑰口令。只有當您的驗證 URL採用 HTTPS 時，mTLS 憑證才有效。儲存連接後將驗證這些欄位。您可以在秘密標籤中引用這些欄位。

  5. 輸入連接的名稱，然後點擊儲存。

  6. 在頁面左側的清單中點擊新連接。

  7. 在「配置」標籤上，配置逾時（毫秒）。逾時套用於連接中配置的所有請求，包括驗證。

  8. 根據需要配置認證和請求。您的連接可以包括其中之一，或兩者。

  9. 如果您有想要加密以便在連接中使用的資訊，請配置機密。

配置驗證詳細資訊

您可以在連接的「驗證」標籤上配置驗證詳細資訊。僅當在用於此連接的範本中啟用驗證時，此標籤才可見。

  1. 在 CXone 中，點擊應用程式選擇器 並選擇自動化與 AI > Integration Hub。

  2. 從頁面左側的「我的連接」中點擊您要使用的連接。

  3. 在「驗證」標籤上，輸入用於驗證請求的 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. 點擊儲存。

在連接中使用秘密

秘密像變數一樣使用。您輸入秘密的格式化名稱來取代其所儲存的值。使用連接時，系統會將秘密名稱替換為其加密值。

您可以在手動或Studio請求中使用秘密。在驗證詳細資訊中，您可以在標頭、查詢參數和正文內容中使用秘密。

在驗證詳細資訊或手動請求中使用秘密

  1. 在 CXone 中，點擊應用程式選擇器 並選擇自動化與 AI > Integration Hub。

  2. 從頁面左側的「我的連接」中點擊您要使用的連接。

  3. 點擊要使用秘密的標籤。秘密可用於驗證和請求標籤。

  4. 依照準則在您想要設定秘密值的位置輸入秘密：

    • 將名稱括在雙括號中。例如，[[ secretName ]]。
    • 使用與「秘密」標籤上的秘密名稱欄位中輸入的名稱完全相同的名稱。
    • 秘密只能在建立秘密的連接中使用。

在Studio請求中使用秘密

要在Studio指令碼中使用秘密，該指令碼必須具有CONNECTAuth或CONNECTREQUEST動作。該動作必須將指令碼連結到包含秘密的連接。

  1. 在Studio中，開啟要在其中使用秘密的指令碼。

  2. 點擊兩下您要對其新增秘密的Snippet動作。

  3. 在Snippet編輯器視窗中，請依照下列準則將秘密新增至您想要使用秘密值的位置：

    • 將名稱括在雙括號中。例如，[[ secretName ]]。
    • 使用與「秘密」標籤上的秘密名稱欄位中輸入的名稱完全相同的名稱。
    • 將括號和秘密名稱括在雙引號 ( " ) 中。例如，"[[ secretName ]]"。如果秘密是字串（例如 URL）的一部分，則必須將整個字串（而不僅僅是秘密）括在雙引號中。例如，"[[ SecretName ]]/location/anotherlocation/"。
    • 秘密只能在建立秘密的連接中使用。必須在指令碼中使用CONNECTAuth或CONNECTREQUEST動作指定連接。

    範例：

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

    • ASSIGN 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請求

當 API 請求無法在Integration Hub中建立，但您希望能夠將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. 點擊頁面頂部的非活躍或活躍來變更狀態。