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;

返回属性