Integration Hub

本頁面中的檔案適用於受控發布 (CR) 版本中的產品或功能。如果您不是 CR 群組成員，但希望獲得更多資訊，請聯絡 CXone 客戶代表。

Integration Hub提供了處理CXone與第三方驗證和 Web 服務整合的標準化方法。Web 服務可以是應用程式、平台或系統。

Integration Hub是用於在CXone中調用 REST API 的方式之一。使用Integration Hub的好處是您可以新增連接並將其用於多個位置。其他方法需要在每次使用時建立連接。

此外，Integration Hub提供增強的安全性，包括 MTLS 和秘密。新增為秘密的變數已加密，無法直接存取。

Integration Hub，左側顯示我的連接清單，右側顯示連接庫。

連接和連接範本

連接定義 API 請求的詳細資訊、驗證詳細資訊以及您要在CXone中使用變數。連接不必包含所有類型的連接資訊。它可以儲存受支援的資訊類型的任意組合。

新增到Integration Hub的每個連接都是基於連接範本建立的。範本定義要套用至將使用該範本建立的所有連接的基本資訊。其中包括：

  • 您正在連接的 Web 服務的名稱。
  • 整合方法。目前，REST API 是唯一受支援的方法。
  • 驗證的類型（如果有）。目前，您可以選擇OAuth2.0或不驗證。
  • 用於驗證的自訂標頭（如果需要）。
  • 可供基於範本發出的請求使用的動詞。動詞是可以透過連接的 Web 服務執行的動作，例如檢索資料或建立記錄。

Integration Hub有兩種類型的範本：NICE擁有的系統範本和您自己建立的範本。系統範本附帶Integration Hub，且無法刪除。其中包括：

  • NICE CXone開發者入口網站：與 API 開發者入口網站中可用的終點整合以減少對Studio Framework 動作的依賴。它使用OAuth2.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中連接中定義的驗證請求。