Zarządzanie kluczami API

Klucze API to unikatowe identyfikatory do uwierzytelniania umożliwiające użytkownikom, programistom lub programom bezpieczny dostęp do API. Są one niezbędne do śledzenia oraz kontrolowania wykorzystania API, pomagają zapobiegać nadużyciom i zapewniają bezpieczną komunikację.

video thumbnail

Używanie kluczy API do łączenia się z interfejsami API Qlik Cloud

Kluczy API można używać do interakcji z dokumentacją interfejsu Qlik API REST. Narzędzia takie jak Postman lub qlik-cli mogą być używane do uzyskiwania dostępu do API. Aby uzyskać więcej informacji, zobacz Przegląd interfejsów API Qlik i qlik-cli.

Przykład: używanie Postman do połączenia z API Qlik

Wykonaj następujące czynności:

Uruchom program Postman.
Ustaw metodę HTTP na GET.
Wprowadź adres URL punktu końcowego API Qlik Cloud.

Na przykład, aby wyświetlić listę wszystkich przestrzeni w dzierżawie:

https://your-tenant.eu.qlikcloud.com/api/v1/spaces
Na karcie Auth (Uwierzytelnianie) wybierz Bearer Token (Token okaziciela) jako Auth Type (Typ uwierzytelnienia).
Wprowadź klucz API w polu Token.
Kliknij Wyślij.

Jeśli żądanie się powiedzie, API zwróci odpowiedź JSON. W tym przykładzie odpowiedź zawierałaby listę przestrzeni.

Włączanie kluczy API w dzierżawie

To ustawienie jest przestarzałe i zostanie usunięte w przyszłym wydaniu. Po usunięciu tworzenie kluczy API będzie kontrolowane wyłącznie przez uprawnienie Zarządzanie kluczami API.

Administratorzy dzierżawy mogą kontrolować możliwość generowania kluczy API przez użytkowników w dzierżawie.

Wykonaj następujące czynności:

W centrum aktywności Administrowanie wybierz Ustawienia.
W sekcji Klucze API włącz lub wyłącz opcję Włącz klucze API.

Konfigurowanie ustawień kluczy API

Wykonaj następujące czynności:

W centrum aktywności Administrowanie wybierz Ustawienia > Klucze API.
W razie potrzeby dostosuj następujące ustawienia:
- Zmień maksymalny termin wygaśnięcia tokenu: ustaw termin wygaśnięcia nowo wygenerowanych tokenów API. Istniejące klucze API zachowają swoją pierwotną wartość ważności. Nie ma górnego limitu dla tej wartości.
- Zmień maksymalną liczbę aktywnych kluczy interfejsu API na użytkownika: ustaw limit liczby kluczy API, które może mieć użytkownik. Limit ten dotyczy tylko nowych kluczy. Jeśli limit zostanie osiągnięty, użytkownicy nie będą mogli tworzyć dodatkowych kluczy. Wartość maksymalna to 1000.

Aby zobaczyć zmiany odzwierciedlone w sekcji Klucze API na stronie profilu użytkownika, być może trzeba będzie odświeżyć stronę w przeglądarce.

Generowanie kluczy API oraz zarządzanie nimi.

Generowanie kluczy API

Aby wygenerować nowe klucze API, musisz mieć niestandardową rolę z uprawnieniem Zarządzanie kluczami API lub uprawnienie to musi być włączone w Ustawieniach domyślnych użytkownika.

Wykonaj następujące czynności:

Kliknij ikonę swojego profilu i wybierz pozycję Ustawienia profilu.
Przejdź do sekcji Klucze API i kliknij Wygeneruj nowy klucz.
Podaj opis i ustaw czas wygaśnięcia klucza API.
Kliknij Wygeneruj, aby utworzyć klucz.
Skopiuj wygenerowany klucz API i zachowaj go w bezpiecznym miejscu. Pamiętaj, że klucza nie można później odzyskać.

Edycja kluczy API

Nazwę klucza API można zmienić po jego utworzeniu.

Usuwanie kluczy API

Usunięcie kluczy API jest trwałe i nie można go cofnąć. Sprawdź, czy to działanie nie zakłóci żadnych trwających procesów ani integracji opartych na kluczu.

Wykonaj następujące czynności:

Kliknij ikonę swojego profilu i wybierz pozycję Ustawienia profilu.
Przejdź do sekcji Klucze API.
Kliknij przy interfejsie API do usunięcia, a następnie wybierz Usuń.
Aby usunąć wszystkie klucze, kliknij Usuń wszystko nad listą kluczy.

Monitorowanie i unieważnianie kluczy API

Wszystkie klucze API powiązane z Twoją dzierżawą możesz wyświetlić w sekcji Klucze API w centrum aktywności Administrowanie. Możesz wyszukiwać klucze według nazwy, identyfikatora lub właściciela.

Statusy kluczy API

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ć.

Odwoływanie kluczy API

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

Odwołanie klucza API powoduje jego natychmiastową dezaktywację, co ma wpływ na wszelkie trwające procesy i bazujące na nim integracje. Odwołanie jest nieodwracalne, a odwołanego klucza API nie można ponownie aktywować.

Wykonaj następujące czynności:

W centrum aktywności Administrowanie wybierz Zdarzenia.
Poszukaj podejrzanych działań, takich jak nadmierne używanie określonego klucza API.
Kliknij obok wydarzenia, aby rozwinąć jego szczegóły, i skopiuj identyfikator klucza API.
Przejdź do sekcji Klucze API i wyszukaj klucz API, korzystając z jego identyfikatora.
Kliknij obok klucza i wybierz opcję Odwołaj. Odwoływać można klucze tylko ze statusem Aktywny.
Aby odwołać wiele kluczy API, zaznacz je w tabeli i kliknij Odwołaj w prawym górnym rogu.

Najlepsze praktyki zarządzania kluczami API

Klucze powinny być poufne: klucze API należy przechowywać w bezpieczny sposób i unikać ujawniania ich w publicznych repozytoriach kodu.
Regeneruj klucze regularnie: okresowo regeneruj klucze API, aby zwiększyć bezpieczeństwo.
Monitoruj użycie: regularnie sprawdzaj aktywność związaną z kluczami API, aby zidentyfikować podejrzane zachowania.

Czy ta strona była pomocna?

Jeżeli natkniesz się na problemy z tą stroną lub jej zawartością — literówkę, brakujący krok lub błąd techniczny — daj nam znać, co możemy poprawić!

Przekaż tu opinię