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ą REST API Qlik. Do uzyskiwania dostępu do API można używać narzędzi takich jak Postman lub qlik-cli. Więcej informacji można znaleźć w sekcjach Przegląd interfejsów API Qlik oraz qlik-cli.

Poświadczenia API zapewniają bezpośredni dostęp programistyczny do Qlik Cloud i nie ograniczają się do przepływów pracy dostępnych w interfejsie użytkownika. Przypisuj role i zakresy OAuth zgodnie z zasadą najmniejszych uprawnień. Traktuj konta usług i poświadczenia API z taką samą ostrożnością jak poświadczenia administratora. Więcej informacji można znaleźć w temacie Kontrola dostępu do API i granice zaufania.

Przykład: Używanie narzędzia Postman do łączenia się z interfejsami API Qlik

Wykonaj następujące czynności:

Uruchom 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 wybierz Bearer Token jako Auth Type.
Wprowadź swój klucz API w polu Token .
Kliknij Send.

Jeśli żądanie zakończy się pomyślnie, API zwróci odpowiedź w formacie JSON. W tym przykładzie odpowiedź będzie zawierać listę przestrzeni.

Konfigurowanie ustawień kluczy API

Wykonaj następujące czynności:

W centrum aktywności Administrowanie przejdź na stronę Ustawienia.
Wybierz kartę Kontrola funkcji.
W sekcji Klucze API dostosuj następujące ustawienia w razie potrzeby:
- Zmień maksymalny czas wygaśnięcia tokenu: Ustaw okres wygaśnięcia dla nowo wygenerowanych tokenów API. Istniejące klucze API zachowają swoją pierwotną wartość wygaśnięcia. Nie ma górnego limitu dla tej wartości.
- Zmień maksymalną liczbę aktywnych kluczy API na użytkownika: Ustaw limit liczby kluczy API, które może posiadać użytkownik. Ten limit dotyczy tylko nowych kluczy. Jeśli limit zostanie osiągnięty, użytkownicy nie będą mogli tworzyć dodatkowych kluczy. Maksymalna wartość to 1000.

Może być konieczne odświeżenie przeglądarki, aby zobaczyć zmiany odzwierciedlone w sekcji Klucze API na stronie ustawień osobistych.

Generowanie kluczy API i zarządzanie nimi

Generowanie kluczy API

Aby wygenerować nowe klucze API, musisz mieć rolę niestandardową z uprawnieniem Zarządzaj kluczami API lub uprawnienie to musi być włączone w ustawieniach Domyślne ustawienia użytkownika.

Wykonaj następujące czynności:

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

Edytowanie kluczy API

Po utworzeniu klucza API można zmienić jego nazwę.

Usuwanie kluczy API

Usunięcie kluczy API jest trwałe i nie można go cofnąć. Upewnij się, że ta czynność nie zakłóci żadnych trwających procesów ani integracji opartych na tym kluczu.

Wykonaj następujące czynności:

Kliknij ikonę swojego profilu użytkownika i wybierz Ustawienia.
Przejdź do sekcji Klucze API.
Kliknij obok klucza API, który chcesz usunąć, i wybierz Usuń.
Aby usunąć wszystkie klucze, kliknij Usuń wszystkie nad listą kluczy.

Monitorowanie i unieważnianie kluczy API

Możesz wyświetlić wszystkie klucze API powiązane z Twoją dzierżawą 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 obecnie w użyciu.
Wygasł: Data ważności została osiągnięta.
Unieważniony: Klucz API został unieważniony i nie może być już używany.

Unieważnianie kluczy API

Jako administrator dzierżawy, aktywne monitorowanie działań związanych z kluczami API jest niezbędne do utrzymania bezpieczeństwa. W przypadku wykrycia podejrzanych działań można unieważnić klucz API.

Unieważnienie klucza API natychmiast go dezaktywuje, co wpływa na wszelkie trwające procesy lub integracje, które na nim polegają. Unieważnienie jest nieodwracalne; unieważnionego klucza API nie można ponownie aktywować.

Wykonaj następujące czynności:

W centrum aktywności Administrowanie przejdź do Zdarzenia.
Poszukaj wszelkich podejrzanych działań, takich jak nadmierne użycie określonego klucza API.
Kliknij obok zdarzenia, aby rozwinąć jego szczegóły i skopiować identyfikator klucza API.
Przejdź do sekcji Klucze API i wyszukaj klucz API za pomocą jego identyfikatora.
Kliknij obok klucza i wybierz Unieważnij. Możesz unieważnić tylko klucze o statusie Aktywny.
Aby unieważnić wiele kluczy API, zaznacz je w tabeli i kliknij Unieważnij w prawym górnym rogu.

Najlepsze praktyki zarządzania kluczami API

Zachowaj poufność kluczy: Przechowuj klucze API w bezpiecznym miejscu i unikaj ujawniania ich w publicznych repozytoriach kodu.
Regularnie generuj ponownie: Okresowo generuj ponownie swoje klucze API, aby zwiększyć bezpieczeństwo.
Monitoruj użycie: Regularnie sprawdzaj działania związane z kluczami API, aby zidentyfikować wszelkie 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ć!

Przekaż tu opinię