Integration Hub

Integration Hubは、サードパーティの認証およびWebサービスとCXoneの統合に対応するための標準化された方法を提供します。Webサービスは、アプリケーション、プラットフォーム、またはシステムである可能性があります。

Integration Hubは、CXoneでRESTAPI呼び出しを操作する方法の1つです。Integration Hubを使用する利点は、接続を追加して複数の場所で使用できることです。他の方法では、使用するたびに接続を構築する必要があります。

さらに、セキュリティを強化する必要があるデータをIntegration Hubに保存することもできます。シークレットとして追加されたデータは暗号化されており、直接アクセスすることはできません。

接続と接続テンプレート

接続では、CXoneで使用するAPIリクエスト、認証の詳細、およびシークレットの詳細を定義します。接続には、すべてのタイプの接続情報が含まれている必要はありません。サポートされている情報のタイプを任意に組み合わせて保持できます。

Integration Hubに追加する各接続は、接続テンプレートに基づいて作成されます。テンプレートは、テンプレートを使用して作成されるすべての接続に適用される基本情報を定義します。これは次を含んでいます：

• 接続先のWebサービスの名前。
• 統合方法。現在、サポートされている方法はREST APIのみです。
• 認証のタイプ(ある場合)。現在、OAuth 2.0または認証なしを選択できます。
• 認証用のカスタムヘッダー(必要な場合)。
• テンプレートに基づいて行われたリクエストで使用できる動詞。動詞は、データの取得やレコードの作成など、接続されたWebサービスで実行できるアクションです。

接続テンプレートは、作成後に変更することはできません。後でテンプレートの内容を変更する必要がある場合は、テンプレートを削除して新しいテンプレートを作成する必要があります。ただし、接続自体は変更できます。テンプレートを削除しても、そのテンプレートを使用して作成された接続には影響しません。

テンプレートは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件のリクエストを含めることができます。一度にアクティブにできるリクエストの数に制限はありません。

マニュアルとStudioリクエスト

Integration Hubは接続のリクエストに対して次の2つのオプションをサポートします。

• 手動：手動リクエストは、Integration Hub[リクエストの追加]ページのオプションを使用して構築されます。オプションにシークレットを使うことができます。手動リクエストは、データが変更されない場合によく使用されます。Studioスクリプトを必要とせず、Integration Hubから直接実行できます。Studioスクリプト内で実行することもできます。

• Studio：場合によっては、APIリクエストをIntegration Hubで手動リクエストとして構築できないことがあります。たとえば、パスパラメーター、変数の置換を必要とするリクエスト、またはSOAP Webサービスに接続するリクエストは、Studioスクリプトで構築する必要があります。ただし、Integration Hub接続でこれらのリクエストを追跡する必要がある場合があります。Studioリクエストオプションを使用するとそれが可能になります。Studioリクエストは、接続のすべての手動リクエストとともに、接続の[リクエスト]タブに表示されます。

シークレット

Integration Hubを使用して、機密情報をシークレットとして保存できます。パスワードやキーなど、追加のセキュリティを必要とするあらゆる情報に使用できます。

シークレットは、それを作成した接続で使用できます。Studioスクリプト内で接続または認証リクエストを実行する場合、その接続からのシークレットをスクリプト内で使用できます。

シークレットは保存時に暗号化されます。Integration Hubはデータを暗号化するために、Advanced Encryption Standard (AES)を使用します。データは暗号化されたデータベースに保存されます。データが復号化されるのは実行時のみです。

Integration HubStudioアクション

認証を使用したり、Studioスクリプトでリクエストを行ったりする場合は、次のStudioアクションを使用します：

• CONNECTAUTH：このアクションによりi、スクリプトに認証の詳細またはシークレットを含めることができます。認証の詳細とシークレットはIntegration Hub接続で定義する必要があります。
• CONNECTREQUEST：このアクションを使用すると、Integration Hub接続で定義されたリクエストを使用できます。手動リクエストとStudioリクエストを使用するには、このアクションが必要です。

これらのアクションの使用に関する重要な事実：

• それにはIntegration Hubが必要です。CXoneシステムでIntegration Hubが有効になっていない場合、アクションは機能しません。
• スクリプトには各アクションのインスタンスを複数含めることができます。
• 変数置換を使用すると、異なるリクエストを実行したり、単一のスクリプトで複数の接続からの認証を使用したりすることができます。
• CXoneでAPI呼び出しを行う他の方法と同様に、接続されたWebサービスからの応答を受信して適切に処理するには、追加のスクリプトが必要です。
• CONNECTAUTHのカスタマイズは一切できません。Integration Hubの接続で定義されている認証リクエストを実行します。