TsgcWebSocketServer_HTTPAPI › プロパティ › APIKeyManager

APIKeyManager プロパティ

接続を受け入れる前に受信APIキーを検証するために使用される、オプションのAPIキーマネージャーコンポーネント。

構文

property APIKeyManager: TsgcWSAPIKeyManager read FAPIKeyManager write SetAPIKeyManager;

デフォルト値

nil

解説

外部の TsgcWSAPIKeyManager コンポーネントを割り当てて、複数のサーバーインスタンスにわたる API キーの発行、ローテーション、検証を一元管理します。割り当てると、すべての受信クライアントはリクエストに有効なキーを提示する必要があります（ヘッダーまたはクエリパラメータ経由）。提示しない場合、接続は拒否されます。このプロパティは SGC_APIKEYMANAGER 条件が定義されている場合にのみコンパイルされます。API Key Manager アドオンを含むエディションで利用可能です。キーベースのアドミッションコントロールを無効にするには未割り当てのままにしてください。

使用例

oServer := TsgcWebSocketServer_HTTPAPI.Create(nil);
oServer.APIKeyManager := oAPIKeyManager;
oServer.Active := true;

プロパティに戻る