Zarządzanie kluczami API
Strona API Keys pozwala tworzyć, przeglądać i zarządzać kluczami, których Twoje aplikacje używają do wywoływania FourA API.
Przeglądanie kluczy
Strona wyświetla wszystkie klucze, do których masz dostęp:
- Klucze osobiste utworzone bezpośrednio przez Ciebie.
- Klucze organizacji jeśli jesteś właścicielem lub administratorem organizacji.
- Klucze zespołu udostępnione Ci w ramach członkostwa w zespole.
Każdy wiersz w tabeli zawiera:
| Kolumna | Co pokazuje |
|---|---|
| Name | Nazwa wyświetlana i (opcjonalny) opis |
| Key | Zamaskowany prefiks (np. pk_live_••••••••) z przyciskiem Reveal obok |
| Owner | ME dla kluczy osobistych, TEAM dla kluczy organizacji lub zespołu |
| IP Allowlist | Ograniczone adresy IP, jeśli zostały ustawione, lub „Wszystkie IP”, jeśli brak ograniczeń |
| Expires | Data wygaśnięcia, jeśli została ustawiona, lub „Nigdy” |
| Status | Active lub Inactive |
| Created | Kiedy klucz został utworzony |
| Last Used | Kiedy klucz ostatnio wykonał request |
Użyj pola wyszukiwania, aby filtrować po nazwie lub opisie, oraz filtra statusu, aby pokazać tylko aktywne lub nieaktywne klucze.
Tworzenie klucza
Kliknij Create Key i wypełnij:
| Pole | Wymagane | Opis |
|---|---|---|
| Name | Tak | Opisowa etykieta (np. „production-scraper” lub „staging-test”) |
| Description | Nie | Notatki o tym, do czego służy ten klucz |
Jeśli należysz do organizacji, możesz również przypisać klucz do tej organizacji zamiast do konta osobistego.
Pełny klucz jest wyświetlany tylko raz, bezpośrednio po utworzeniu, w oknie dialogowym gotowym do skopiowania. Możesz go również wyświetlić później za pomocą opcji Reveal (patrz poniżej), o ile klucz został utworzony po wdrożeniu funkcji odkrywania.
Klucze używają prefiksu pk_live_ i wyglądają następująco: pk_live_a1b2c3d4e5f6.... Po utworzeniu nowego klucza otrzymasz potwierdzenie e-mailem.
Odkrywanie klucza
Kliknij ikonę oka obok zamaskowanego prefiksu klucza, aby ponownie zobaczyć jego pełną wartość secret. Dashboard poprosi Cię o potwierdzenie, a następnie otworzy okno dialogowe z jawnym kluczem, przyciskiem kopiowania i 15-sekundowym odliczaniem. Po zakończeniu odliczania okno dialogowe usunie secret ze strony.
Każde odkrycie klucza jest rejestrowane w logu audytowym (audit log), ponieważ ujawnia ono aktywne dane uwierzytelniające.
Starsze klucze (Legacy)
Klucze utworzone przed wdrożeniem tej funkcji wyświetlają ikonę kłódki zamiast oka i nie można ich odkryć. Zapisany został tylko ich hash, więc oryginalny secret jest nie do odzyskania. Aby zaktualizować starszy klucz, kliknij menu akcji i wybierz Regenerate. Od tego momentu nowy secret będzie można odkryć.
Kto może odkryć klucz
| Rola | Może odkryć |
|---|---|
| Właściciel klucza | Tak |
| Właściciel / admin organizacji (dla kluczy organizacji) | Tak |
Członek zespołu z uprawnieniem write lub admin |
Tak |
Członek zespołu z uprawnieniem read |
Nie |
Edycja klucza
Kliknij Edit w dowolnym wierszu, aby zaktualizować:
- Nazwę wyświetlaną i opis
- Listę dozwolonych IP (jeden adres IP w linii; pozostaw puste, aby zezwolić na dowolny źródłowy IP)
- Datę wygaśnięcia (pozostaw puste, aby klucz nigdy nie wygasł)
Inne ustawienia (przypisanie do organizacji, właściciel) nie podlegają edycji. Jeśli potrzebujesz innego właściciela, utwórz nowy klucz.
Aktywacja i dezaktywacja
Użyj przycisku Disable / Enable w wierszu klucza, aby przełączyć jego status. Dezaktywacja klucza blokuje wszystkie requesty API, które go używają. Możesz go aktywować ponownie w dowolnym momencie. Zmiana wchodzi w życie w ciągu kilku sekund.
Regeneracja klucza
Jeśli podejrzewasz, że klucz został ujawniony, otwórz menu akcji (przycisk z trzema kropkami) i wybierz Regenerate. Spowoduje to utworzenie nowego secret dla tego samego identyfikatora klucza. Stary secret natychmiast przestanie działać. Wszystkie pozostałe ustawienia (nazwa, przypisanie do organizacji, lista dozwolonych IP, data wygaśnięcia) pozostaną bez zmian.
Nowy secret można odkryć również po zamknięciu okna dialogowego, więc nie musisz kopiować go idealnie za pierwszym razem.
Usuwanie klucza
Otwórz menu akcji i wybierz Delete. Domyślnie usunięcie dezaktywuje klucz (soft delete). Możesz go trwale usunąć z poziomu okna potwierdzenia.
Po usunięciu klucza otrzymasz powiadomienie e-mailem.
Klucze organizacji
Klucze utworzone w ramach organizacji są udostępniane jej członkom na podstawie ich ról:
- Właściciele i administratorzy widzą i edytują wszystkie klucze organizacji.
- Członkowie widzą tylko te klucze, które są przypisane do zespołów, do których należą.
Klucze organizacji są automatycznie dodawane do domyślnego zespołu organizacji podczas ich tworzenia.
Uprawnienia do kluczy poprzez zespoły
Zespoły kontrolują, kto ma dostęp do poszczególnych kluczy. Każde przypisanie klucza do zespołu ma określony poziom uprawnień:
| Uprawnienie | Widok klucza | Odkrywanie | Edycja ustawień klucza |
|---|---|---|---|
| read | Tak | Nie | Nie |
| write | Tak | Tak | Tak |
| admin | Tak | Tak | Tak |
Powiązane
- Uwierzytelnianie: Jak klucze API współpracują z API
- Organizacje i zespoły: Konfiguracja współdzielonego dostępu
- Przegląd Dashboardu: Wszystkie sekcje panelu