Zarządzanie kluczami API
Strona kluczy API pozwala na tworzenie, przeglądanie i zarządzanie kluczami, których używają twoje aplikacje do wywoływania API FourA.
Przeglądanie kluczy
Strona pokazuje każdy klucz, do którego masz dostęp:
- Klucze osobiste, które utworzyłeś bezpośrednio.
- Klucze organizacji, jeśli jesteś właścicielem lub administratorem organizacji (org), albo jeśli klucz, którego jesteś właścicielem, został przeniesiony do jednej z twoich organizacji.
Każdy wiersz w tabeli przedstawia:
| Kolumna | Co pokazuje |
|---|---|
| Name | Nazwa wyświetlana i (opcjonalny) opis |
| Key | Zamaskowany prefiks (np. pk_live_••••••••) z przyciskiem Reveal obok |
| Owner | Personal dla kluczy osobistych lub nazwa organizacji dla kluczy należących do organizacji |
| Status | Aktywny lub Nieaktywny |
| Created | Kiedy klucz został utworzony |
| Last Used | Kiedy klucz ostatnio wykonał żądanie (request) |
Użyj pola wyszukiwania, aby filtrować po nazwie lub opisie, oraz filtru statusu, aby pokazać tylko aktywne lub nieaktywne klucze. Każdy nagłówek kolumny można sortować.
Tworzenie klucza
Kliknij Create Key i wypełnij:
| Pole | Wymagane | Opis |
|---|---|---|
| Name | Tak | Etykieta opisowa (np. "production-scraper" lub "staging-test") |
| Description | Nie | Notatki o tym, do czego służy ten klucz |
| Owner | Tak, jeśli jesteś w organizacji | Personal, lub jedna z organizacji, do których należysz. Selektor pojawia się tylko wtedy, gdy masz co najmniej jedną organizację. |
Pełny klucz jest wyświetlany raz, zaraz po utworzeniu, w oknie dialogowym gotowym do skopiowania. Możesz również przywrócić go później za pomocą opcji Reveal (zobacz poniżej).
Klucze używają prefiksu pk_live_ i wyglądają jak pk_live_a1b2c3d4e5f6.... Po utworzeniu nowego klucza otrzymasz potwierdzenie e-mail.
Odkrywanie klucza
Kliknij ikonę oka obok zamaskowanego prefiksu klucza, aby ponownie zobaczyć jego pełny sekret. Dashboard prosi o potwierdzenie, a następnie otwiera okno dialogowe ze zwykłym kluczem, przyciskiem kopiowania i krótkim odliczaniem. Po zakończeniu odliczania okno wymazuje sekret ze strony.
Każde odkrycie jest rejestrowane w logu audytu (audit log), ponieważ ujawnia aktywne poświadczenia.
Klucze Legacy
Klucze utworzone przed wdrożeniem funkcji odkrywania mają ikonę kłódki zamiast oka i nie można ich odkryć. Zapisano tylko ich hash, więc pierwotny sekret jest nie do odzyskania. Aby zaktualizować klucz legacy, kliknij menu akcji i wybierz Regenerate. Od tego momentu nowy sekret będzie można odkrywać.
Kto może odkryć klucz
| Rola | Może odkryć |
|---|---|
| Właściciel klucza | Tak |
| Właściciel lub administrator organizacji (dla kluczy organizacji) | Tak |
| Ktokolwiek inny | Nie |
Edycja klucza
Kliknij Edit w dowolnym wierszu, aby zaktualizować nazwę wyświetlaną i opis. Własność (osobista vs organizacja) nie jest tutaj zmieniana. Użyj opcji Transfer poniżej, aby przenieść klucz między właścicielami.
Aktywacja i dezaktywacja
Użyj przycisku Disable / Enable w wierszu, aby przełączyć status klucza. Dezaktywacja klucza blokuje wszystkie żądania API (API requests), które z niego korzystają. Możesz go ponownie aktywować w dowolnym momencie. Zmiana wchodzi w życie w ciągu kilku sekund.
Regeneracja klucza
Jeśli podejrzewasz, że klucz został przejęty, otwórz menu akcji (przycisk z trzema kropkami) i wybierz Wygeneruj ponownie. Utworzy to nowy sekret dla tego samego key ID. Stary sekret natychmiast przestanie działać. Nazwa, przypisanie do organizacji i inne ustawienia pozostają bez zmian.
Nowy sekret można wyświetlić po zamknięciu okna dialogowego, więc nie musisz go idealnie skopiować za pierwszym razem.
Przenoszenie klucza
Każdy wiersz ma w menu akcję Przenieś. Użyj jej, aby przenosić klucze między własnością osobistą a organizacją bez ponownego generowania sekretu. Key ID, jego metryki i historia aktywności zostają zachowane; zmienia się tylko właściciel.
Częste przypadki:
- Przeniesienie klucza osobistego utworzonego dla wspólnego projektu do organizacji, aby współpracownik mógł nim zarządzać po tobie.
- Przypisanie klucza organizacji z powrotem do siebie, jeśli projekt zostanie wydzielony.
Możesz przenieść klucz, którego jesteś właścicielem (osobisty), do dowolnej organizacji, w której jesteś właścicielem lub administratorem, a klucz organizacji, którą zarządzasz, możesz przenieść do siebie lub między zarządzanymi organizacjami.
Usuwanie klucza
Otwórz menu akcji i wybierz Usuń. Usunięcie klucza, który był wcześniej używany, powoduje jego miękkie usunięcie (soft-delete): klucz przestaje uwierzytelniać, ale jego historia aktywności i metryki pozostają nienaruszone. Klucze, które nigdy nie były używane, mogą zostać trwale usunięte (hard-delete).
Otrzymasz powiadomienie e-mail, gdy klucz zostanie usunięty.
Klucze organizacji
Klucze należące do organizacji są widoczne dla właścicieli i administratorów organizacji. Członkowie bez roli właściciela lub administratora ich nie widzą.
Użycie klucza należącego do organizacji obciąża plan właściciela organizacji.
Powiązane
- Uwierzytelnianie: Jak klucze API działają z API
- Organizacje i zespoły: Konfigurowanie współdzielonego dostępu
- Przegląd panelu: Wszystkie sekcje panelu