APIKeyManager Właściwość

Opcjonalny komponent zarządzania kluczami API służący do weryfikacji przychodzących kluczy API przed akceptacją połączenia.

Składnia

property APIKeyManager: TsgcWSAPIKeyManager read FAPIKeyManager write SetAPIKeyManager;

Wartość domyślna

nil

Uwagi

Przypisuje zewnętrzny komponent TsgcWSAPIKeyManager, aby scentralizować wydawanie, rotację i walidację kluczy API na wielu instancjach serwera. Po przypisaniu każdy przychodzący klient musi przedstawić ważny klucz w żądaniu (przez nagłówek lub parametr zapytania), w przeciwnym razie połączenie jest odrzucane. Ta właściwość jest kompilowana tylko wtedy, gdy zdefiniowany jest warunek SGC_APIKEYMANAGER. Jest dostępna w edycjach zawierających dodatek API Key Manager. Pozostawienie bez przypisania wyłącza kontrolę dostępu opartą na kluczach.

Przykład


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

Wróć do Właściwości