Zarządzanie kluczami API

Klucze API służą jako unikatowe identyfikatory uwierzytelniania umożliwiające użytkownikom, programistom lub programom bezpieczny dostęp do API . Klucze API są często używane do śledzenia i kontrolowania sposobu używania interfejsu API, aby zapobiec jego nadużyciom.

Przegląd kluczy API

W sekcji Klucze API Konsola zarządzania możesz wyświetlić wszystkie klucze API powiązane z Twoją dzierżawą. Możesz wyszukiwać klucze według nazwy, identyfikatora lub właściciela.

Klucze API mogą mieć następujące statusy:

• Aktywny: klucz API jest aktualnie używany.
• Wygasł: osiągnięto datę ważności.
• Odwołany: klucz API został unieważniony i nie można go już używać.

Administratorzy dzierżawy mogą włączyć generowanie kluczy API, a także monitorować i unieważniać klucze API. Aby generować, edytować lub usuwać klucze API, wymagana jest rola Programista. Administratorzy dzierżawy mogą przypisywać tę rolę użytkownikom, w tym sobie samym.

Włączanie kluczy API w dzierżawie

Klucze interfejsu API są domyślnie wyłączone. Administratorzy dzierżawy mogą włączyć klucze API w ramach dzierżawy.

Wykonaj następujące czynności:

1. W funkcji Konsola zarządzania przejdź do pozycji Ustawienia.
2. Znajdź sekcję Klucze API i wybierz opcję Włącz klucze API.
3. W razie potrzeby dostosuj następujące ustawienia:

   • Zmień maksymalny termin wygaśnięcia tokenu: modyfikuje datę wygaśnięcia nowo wygenerowanych tokenów. Istniejące klucze API zachowują swoją pierwotną wartość ważności. Nie ma maksymalnego limitu tej wartości.

     InformacjaAby zobaczyć zmiany tej wartości odzwierciedlone w sekcji Klucze API na stronie profilu użytkownika, być może trzeba będzie odświeżyć stronę w przeglądarce.
   • Zmień maksymalną liczbę aktywnych kluczy interfejsu API na użytkownika: to ustawienie wpływa tylko na nowe klucze API. Jeśli limit zostanie osiągnięty, tworzenie nowych kluczy API spotka się z odmową. Wartość maksymalna to 1000.

4. Aby rozpocząć generowanie kluczy API, kliknij Wygeneruj nowy. Spowoduje to przekierowanie do sekcji Klucze API na stronie profilu użytkownika, gdzie możesz utworzyć nowe klucze.

Generowanie kluczy API

Klucze interfejsu API można generować z huba. Najpierw sprawdź, czy są spełnione następujące wymagania:

• Masz aktywną licencję.

• Opcja Włącz klucze API jest włączona w funkcji Konsola zarządzania.
• Masz rolę Programisty.

Wykonaj następujące czynności:

1. Kliknij ikonę profilu użytkownika w prawym górnym rogu i wybierz pozycję Ustawienia profilu.

2. W sekcji Klucze API kliknij Wygeneruj nowy klucz.

3. Podaj opis i czas wygaśnięcia klucza API.

4. Kliknij Wygeneruj, aby utworzyć klucz.

5. Natychmiast skopiuj wygenerowany klucz API i zachowaj go w bezpiecznym miejscu. Klucza nie można później odzyskać.

Po utworzeniu możesz edytować nazwę klucza interfejsu API lub w razie potrzeby go usunąć.

Za pomocą klucza API możesz eksplorować dokumentację REST API na qlik.dev za pomocą narzędzi takich jak Postman lub zainstalować qlik-cli, aby uzyskać dostęp do możliwości Qlik bezpośrednio z wiersza polecenia. Aby uzyskać więcej informacji, zobacz Przegląd interfejsów API Qlik i qlik-cli.

Monitorowanie i unieważnianie kluczy API

Dla administratora dzierżawy konieczne jest monitorowanie kluczowych działań z kluczem API ze względów bezpieczeństwa. W przypadku wykrycia podejrzanych działań możesz unieważnić klucz API.

Pamiętaj, że unieważnienie klucza API powoduje jego natychmiastową dezaktywację, co ma wpływ na wszelkie trwające procesy i bazujące na nim integracje. Unieważnienie jest nieodwracalne, a unieważnionego klucza API nie można ponownie aktywować.

Wykonaj następujące czynności:

1. W funkcji Konsola zarządzania przejdź do sekcji Wydarzenia.

2. Poszukaj podejrzanych działań, takich jak nadmierne używanie określonego klucza API.

3. Kliknij obok wydarzenia, aby rozwinąć jego szczegóły, i skopiuj identyfikator klucza API.

4. Przejdź do sekcji Klucze API i wyszukaj klucz API, korzystając z jego identyfikatora.

5. Kliknij obok klucza i wybierz opcję Odwołaj. Odwoływać można klucze tylko ze statusem Aktywny.

6. Aby odwołać wiele kluczy API, zaznacz je w tabeli i kliknij Odwołaj w prawym górnym rogu.

Usuwanie kluczy API

Usunięcie kluczy API powoduje ich trwałe usunięcie z systemu. Usunięcie klucza API jest nieodwracalne i powoduje natychmiastowe odebranie jego uprawnień dostępu. Sprawdź, czy to działanie nie zakłóci żadnych trwających procesów ani integracji opartych na kluczu.

Do usuwania kluczy API potrzebna jest rola programisty.

Wykonaj następujące czynności:

1. Kliknij ikonę profilu użytkownika w prawym górnym rogu i wybierz pozycję Ustawienia profilu.

2. Wybierz sekcję Klucze API.

3. Kliknij przy interfejsie API do usunięcia, a następnie wybierz Usuń.

4. Jeśli chcesz usunąć wszystkie klucze, kliknij Usuń wszystko nad listą kluczy API.