Klucze API

Zakładka Klucze API umożliwia generowanie i zarządzanie tajnymi kluczami wykorzystywanymi do integracji systemu z innymi aplikacjami. Każdy klucz działa w oparciu o przypisane grupy uprawnień, co oznacza, że ma dostęp tylko do tych zasobów i funkcji, na które pozwala wybrana konfiguracja. Dzięki temu możliwe jest bezpieczne i kontrolowane korzystanie z API systemu.

Opis działania

Aby wygenerować nowy klucz, wybierz przycisk + Dodaj klucz znajdujący się nad tabelą. Otworzy się okno, w którym należy (pola obowiązkowe):

• wprowadzić nazwę klucza,

• przypisać grupy uprawnień poprzez opcję Dodaj grupy.

Po wybraniu tej opcji wyświetli się lista dostępnych grup w systemie. Są to grupy uprawnień odpowiadające uprawnieniom administratorów. Okno wyboru działa analogicznie jak w innych częściach systemu i umożliwia przypisanie wielu grup jednocześnie.

Po poprawnym uzupełnieniu danych można wybrać:

• Dodaj klucz - aby utworzyć klucz,

• Anuluj - aby przerwać operację.

Po utworzeniu klucza system wyświetli jego wartość tylko raz.

Uwaga: Klucz należy zapisać w bezpiecznym miejscu. Nie będzie możliwości jego ponownego wyświetlenia. Każda osoba posiadająca klucz może wykonywać operacje w systemie w ramach przypisanych uprawnień. W przypadku utraty klucza konieczne jest wygenerowanie nowego i zaktualizowanie go w integracjach.

Dostępny jest przycisk Kopiuj do schowka, który umożliwia szybkie zapisanie klucza.

Tabela kluczy API

W zakładce dostępna jest tabela zawierająca wszystkie utworzone klucze. Zawiera ona następujące informacje:

• Nazwa - nazwa nadana przez administratora,

• Status (aktywny / nieaktywny) - określa, czy klucz może być używany; dezaktywowany klucz nie obsługuje zapytań,

• Klucz - widoczny jest jedynie skrót (początek i koniec); pełna wartość dostępna jest tylko podczas generowania,

• Data utworzenia - moment wygenerowania klucza,

• Data ostatniego użycia - informacja, kiedy klucz był ostatnio wykorzystany,

• Utworzony przez - administrator, który utworzył klucz,

• Grupy - przypisane grupy uprawnień określające zakres dostępu klucza (API nie uzyska większych uprawnień niż te przypisane).

Więcej informacji o zarządzaniu uprawnieniami i grupami znajduje się w osobnej sekcji dokumentacji.

Zarządzanie kluczami

Dla każdego klucza dostępne są następujące operacje:

• aktywacja i dezaktywacja,

• edycja nazwy,

• zmiana przypisanych grup uprawnień,

• usunięcie klucza (wymaga potwierdzenia).

W przypadku utraty klucza nie ma możliwości jego odzyskania - należy wygenerować nowy i podmienić go w używanych integracjach.