外部サービス設定
設定テーブル
管理 > 統合 > 外部サービス > 設定テーブルで外部サービスを設定します。次のプロパティを入力します。
| プロパティ | 定義 |
|---|---|
|
識別子
|
サービス設定の一意の識別子
|
|
URL
|
呼び出すサーバーのベースURLを指定します。クライアントとサーバー間の通信を暗号化するにはHTTPSを使用します。
URLの形式は次のとおりです。
http[s]://<host>[:<port>]/{path}{?<queryParameters>}
各要素は次のとおりです。
|
|
使用タイプ
|
外部サービスの使用タイプ (Assistant AI および/または REST サービス) を定義します。
|
|
認証タイプ
|
APIリクエストを行う際のユーザー認証を定義します。APIとそのリソースにアクセスするには、basic、custom、EBX、noneのタイプを使用します。
|
認証タイプ
認証により、許可されたユーザーのみがサービスとそのリソースにアクセスできるようになります。次の認証タイプがサポートされています。
| タイプ | 説明 |
|---|---|
| Basic | 有効なユーザー名とパスワードを必要とする、シンプルで高速なHTTP認証方法です。資格情報はBase64でエンコードされ、HTTPリクエストヘッダーに含まれます。 パスワードは、強力な暗号化によりEBX®リポジトリに安全に保存されます。詳細については、「キーストアファイル」を参照してください。 |
| EBX | EBX組み込みRESTfulサービスへのアクセスを有効にします。有効なユーザー名とパスワードを提供する必要があります。 パスワードは、強力な暗号化によりEBX®に安全に保存されます。詳細については、「キーストアファイル」を参照してください。 |
| Custom | 有効なキー名とキー値を提供することにより、APIキー、トークン、OAuthなどのカスタム認証を有効にします。 キーの値は機密である場合とそうでない場合があります。すべてのキーは、機密であるかどうかにかかわらず、異なる名前を持つ必要があります。そうでない場合、検証エラーが表示されます。 秘密鍵は、強力な暗号化によりEBX®リポジトリに安全に保存されます。詳細については、「キーストアファイル」を参照してください。 |
| None | 認証は不要です。 |
キーストアファイル
はじめに
EBX®は、データの暗号化または署名に使用される秘密鍵を保存するためにキーストアファイルを使用します。このファイルの場所と関連する詳細は、*キーストア機密プロパティファイル*によって指定されます。
キーストア機密プロパティファイル
機密プロパティは、キーストアファイルの場所、および秘密鍵のエイリアスやパスワードなどのその他の関連情報を指定します。
機密プロパティは、
ebx.propertiesファイルとは別のプロパティファイルに保存します。デフォルトでは、このファイルは ebx-keystore-sensitive.propertiesという名前で、EBX®リポジトリと同じディレクトリに保存されます。ebx.propertiesファイルでプロパティ ebx.keystore.sensitive.properties.pathを設定することにより、場所を変更できます。
このプロパティファイルの形式は次のとおりです。
## This file contains sensitive properties of the EBX application keystore.
## Access to this file should be restricted to the operating system user that is running EBX.
##
## The keystore type.
ebx.keystore.type=PKCS12
##
## The keystore path.
## If relative, it's absolute path is resolved against this file's folder.
## This property should be removed if the keystore type is not file based.
ebx.keystore.path=ebx-keystore.p12
##
## The keystore password.
ebx.keystore.password.obf=XjJZFfsUXfrzq66GJxfBIa/ulHdPqaeC6/MMMHLyA11XvQZ6/rFqVbmjDZgDL5GPRcDc1+OQQpw6Fg==
##
## The alias of the secret key used to encrypt password type values.
ebx.keystore.key.passwordType.alias=ebx.passwordType
##
## The password of the secret key used to encrypt password type values.
## For PKCS12 keystores, should be the same as the keystore password.
ebx.keystore.key.passwordType.password.obf=XjJZFfsUXfrzq66GJxfBIa/ulHdPqaeC6/MMMHLyA11XvQZ6/rFqVbmjDZgDL5GPRcDc1+OQQpw6Fg==
##
## The alias of the secret key used to sign web tokens.
ebx.keystore.key.webToken.alias=ebx.webToken
##
## The password of the secret key used to sign web tokens.
## For PKCS12 keystores, should be the same as the keystore password.
ebx.keystore.key.webToken.password.obf=XjJZFfsUXfrzq66GJxfBIa/ulHdPqaeC6/MMMHLyA11XvQZ6/rFqVbmjDZgDL5GPRcDc1+OQQpw6Fg==
自動インストール
初回起動時に、EBX®は
ebx-keystore.p12ファイルと ebx-keystore-sensitive.propertiesファイルをEBX®リポジトリフォルダーに作成します。秘密鍵は自動的に生成され、インストールに固有のものです。
ステージング
デフォルトでは、EBX®ステージングサーバーは異なる秘密鍵を持っています。あるステージングサーバーによって暗号化されたデータは、別のサーバーでは復号化できません。この問題を回避し、すべてのEBX®ステージングサーバー間で鍵を整合させるには、次の手順を実行します。
-
同じキーストアファイル (デフォルトでは
ebx-keystore.p12) をコピーします -
キーストア機密プロパティファイル (デフォルトでは
ebx-keystore-sensitive.properties) をすべてのEBX®ステージングサーバーインストールにコピーします