Integration Hub

Integration Hub提供了一個處理與外部系統和服務整合的中心位置。 它允許您建立標準化的 RESTAPI關閉 應用程式編程介面。 允許您可以透過將您的 CXone Mpower 系統與其他軟體連接來實現某些功能的自動化。 連接,您可以在多個Studio指令碼中使用這些連接。 這避免了在您想要透過 API 與外部通訊時重複建立相同請求的需要。 相反地,您可以在Integration Hub中建置一次請求,然後在需要的地方重複使用。 這簡化並加快了指令碼編寫過程。

Integration Hub 也讓您的整合更加安全。 它會加密 API 認證,因此每次使用它們時,它們都不會在指令碼中公開。 Studio指令碼儲存為純文字,因此您無法直接在指令碼中安全地將重要憑證作為變數儲存,例如用於API請求的權杖。 Integration Hub可讓您快速將驗證請求新增至指令碼,然後在後續API呼叫中安全地使用檢索到的認證。 您也可以將 mTLS 憑證新增至 API 請求。

Integration Hub 是自動化與 AI 應用程式CXone Mpower的一部分。 如果您有啟動自動化和 AI 權限,則可以在新視窗中從應用程式開啟CXone Mpower,然後點擊Integration Hub

連接

連接定義與外部服務整合的詳細資料,例如 API 要求、驗證流程和變數。 例如,您可以為Salesforce建立連接範本。 這將定義連接Salesforce所需的基本詳細資訊,例如驗證類型和支援的方法。 從此範本中,您將建立一個連接,可讓您填寫範本中的特定詳細資訊,以及更具體的詳細資訊,例如您想要向Salesforce發出的特定API請求。

連接範本

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

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

連接不必包含所有類型的連接資訊。 它可以儲存受支援的資訊類型的任意組合。

所有連接範本都可以在 Integration Hub的連接庫中找到。 可在Studio指令碼中使用的範本列在Integration Hub中的「我的連接」下。 您最多可以建立 50 個連線(在「我的連接清單中)。 連接庫中的範本數量沒有限制。

無法修改所有範本。 但是,可以刪除您的自訂範本。 如果稍後需要變更自訂範本中的某些內容,可以刪除該範本並建立新範本。 連接本身是可以修改的。 刪除自訂範本不會影響使用該範本建立的連接。

系統範本

Integration Hub有兩種類型的範本:NiCE擁有的系統範本和您自己建立的範本。 系統範本附帶Integration Hub,且無法刪除。 目前,Integration Hub包括一個系統範本:

  • CXone Mpower開發人員門戶:與 CXone Mpower 開發人員門戶 上記錄的API終結點集成。 這是為了減少對Studio 框架操作的依賴。 它使用OAuth2.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:應用程式/ 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 秒內對 API 調用失敗次數超過 50%,斷路器就會啟動。

  • 要觸發斷路器,Integration Hub必須在 30 秒窗口期內嘗試對單個 API 調用超過 100 次。

  • 斷路器啟動 30 秒。

  • 失敗原因可以在 Studio_err 變數中擷取的 追踪日誌中存取。

稽核歷程記錄

Integration Hub中的每個連接都有一個變更日誌。 每當建立或更新連線時,都會記錄以下詳細資訊:

  • 日期:進行變更的日期。

  • 修改者:誰做了更改。

  • 個人檔案名稱:連線的名稱。

  • 動作:發生了什麼,例如連接是已建立還是已修改。

使用者將能夠從連線設定中的新稽核按鈕存取此記錄。