Zarządzanie kluczami API
Strona API Keys pozwala tworzyć, przeglądać i zarządzać kluczami, których aplikacje używają do wywoływania FourA API.
Przeglądanie kluczy
Strona wyświetla każdy klucz, do którego masz dostęp: Twoje klucze osobiste oraz każdy klucz należący do organizacji, do której należysz. Członkostwo daje uprawnienia, więc zwykły członek widzi również klucze organizacji.
| Kolumna | Co zawiera |
|---|---|
| Name | Nazwa wyświetlana oraz, jeśli go ustawiono, opis |
| Owner | Personal lub nazwa organizacji |
| Key Prefix | Zamaskowany prefiks (pk_live_••••••••) z przyciskiem Reveal lub ikona kłódki przy starszym kluczu |
| Status | Active lub Inactive |
| Created | Data utworzenia klucza |
| Last Used | Data wykonania ostatniego zapytania przez klucz |
Wyszukuj po nazwie lub opisie, filtruj do Active lub Inactive i sortuj według dowolnego nagłówka. Kierunek sortowania przełącza się kolejno: malejąco, rosnąco, wyłączone.
Filtr Owner
Jeśli należysz do co najmniej jednej organizacji, obok pola wyszukiwania pojawi się lista rozwijana Owner: Everything, Personal lub pojedyncza pozycja dla każdej organizacji. Zawęża ona listę do kluczy danego właściciela, a ten sam element sterujący na stronach Overview, Metrics, Activity oraz Proxy podąża za Twoim wyborem, dzięki czemu wszystkie pięć stron zawsze pokazuje ruch tego samego podmiotu.
Tworzenie klucza
Kliknij Create Key nad listą (Create API key na pustej stronie przed utworzeniem pierwszego klucza) i wypełnij:
| Pole | Wymagane | Opis |
|---|---|---|
| Name | Tak | Opisowa etykieta, na przykład "production-scraper" lub "staging-test" |
| Description | Nie | Notatki o przeznaczeniu tego klucza |
| Owner | Tak, jeśli należysz do organizacji | Personal lub dowolna organizacja, do której należysz. Selektor pojawia się tylko wtedy, gdy masz przynajmniej jedną. |
Każdy członek organizacji może utworzyć klucz będący jej własnością, niezależnie od swojej roli. Taki jest cel tego ustawienia: użycie klucza organizacji obciąża właściciela organizacji, więc programista nie potrzebuje osobistego klucza, który po cichu obciążałby jego zamiast firmy.
Pełny klucz jest wyświetlany tylko raz, bezpośrednio po utworzeniu, w oknie dialogowym gotowym do skopiowania. Możesz go później wyświetlić ponownie za pomocą opcji Reveal. Klucze używają prefiksu pk_live_ i wyglądają jak pk_live_a1b2c3d4e5f6.... Otrzymasz wiadomość e-mail z potwierdzeniem utworzenia klucza.
Odkrywanie klucza
Kliknij ikonę oka obok zamaskowanego prefiksu klucza, aby ponownie zobaczyć jego pełny klucz tajny. Panel poprosi o potwierdzenie, a następnie otworzy okno dialogowe z jawnym kluczem, przyciskiem kopiowania i krótkim odliczaniem. Po zakończeniu odliczania okno usuwa klucz ze strony.
Każde odkrycie jest rejestrowane w dzienniku audytu, ponieważ ujawnia aktywne dane uwierzytelniające.
Każdy, komu udostępniono klucz, może go odkryć: jego osobisty właściciel lub dowolny członek organizacji, która jest jego właścicielem.
Starsze klucze
Klucze utworzone przed wdrożeniem funkcji odkrywania mają ikonę kłódki zamiast oka i nie można ich podejrzeć. Zapisano wyłącznie ich hash, więc oryginalny secret jest nie do odzyskania. Aby zaktualizować starszy klucz, otwórz menu akcji i wybierz Regenerate. Nowy secret będzie od tej chwili dostępny do podejrzenia.
Uprawnienia ról
W przypadku klucza osobistego masz pełne uprawnienia. W przypadku klucza organizacji obowiązują trzy poziomy:
| Akcja | Member | Admin | Owner |
|---|---|---|---|
| Użycie klucza i podejrzenie go | Tak | Tak | Tak |
| Zmiana nazwy, edycja opisu | Tak | Tak | Tak |
| Włączenie lub wyłączenie | Nie | Tak | Tak |
| Wygenerowanie nowego secretu | Nie | Tak | Tak |
| Usunięcie | Nie | Tak | Tak |
| Przeniesienie poza organizację | Nie | Nie | Tak |
Opcje Disable i Edit pozostają w wierszu, ale są wyszarzone wraz z informacją o przyczynie. Opcje Regenerate, Transfer oraz Delete nie pojawiają się w menu, jeśli Twoja rola na to nie pozwala. API odrzuca te same akcje, więc integracja nie może ominąć ograniczeń interfejsu.
Podział zależy od wpływu danej akcji na osoby współdzielące klucz. Zmiana nazwy jest nieszkodliwa. Wygenerowanie nowego secretu lub wyłączenie natychmiast zatrzymuje integracje wszystkich współpracowników. Przeniesienie klucza poza organizację odbiera go firmie i przypisuje jego użycie do planu przejmującego, dlatego ta akcja jest zarezerwowana wyłącznie dla roli Owner.
Edycja klucza
Kliknij Edit, aby zaktualizować nazwę i opis. Właściciel nie jest zmieniany w tym oknie dialogowym: użyj opcji Transfer.
Opcja View Metrics w menu akcji otwiera widok Overview przefiltrowany dla tego klucza.
Aktywacja i dezaktywacja
Użyj opcji Disable lub Enable w wierszu. Dezaktywacja klucza blokuje każde żądanie API, które go używa, i można go ponownie aktywować w dowolnym momencie. Zmiana zaczyna obowiązywać w ciągu kilku sekund.
Ponowne generowanie klucza
Jeśli podejrzewasz, że klucz został ujawniony, otwórz menu akcji i wybierz Regenerate. Spowoduje to utworzenie nowego secretu dla tego samego ID klucza. Stary secret natychmiast przestaje działać. Nazwa, właściciel i wszystkie inne ustawienia pozostają bez zmian.
Nowy secret można podejrzeć także po zamknięciu okna dialogowego, więc nie musisz go kopiować od razu.
Przenoszenie klucza
Opcja Transfer w menu akcji przenosi klucz między kontem osobistym a organizacją bez generowania nowego secretu. ID klucza, jego metryki oraz historia aktywności zostają zachowane. Zmienia się tylko właściciel, a wraz z nim to, do kogo trafiają rachunki za użycie.
| Przeniesienie | Kto może to zrobić |
|---|---|
| Klucz osobisty do organizacji | Każdy, kto należy do tej organizacji |
| Klucz organizacji na własne konto | Owner organizacji |
| Między dwiema organizacjami | Owner organizacji, z której klucz jest przenoszony |
Klucz przeniesiony do organizacji trafia do jej domyślnego zespołu "Everyone", dzięki czemu staje się widoczny dla członków. Klucz przeniesiony poza organizację opuszcza każdy zespół, do którego należał.
Usuwanie klucza
Otwórz menu akcji i wybierz Delete. Usunięcie klucza, który był wcześniej używany, wyłącza go: klucz przestaje uwierzytelniać i pozostaje na liście ze statusem Inactive, dzięki czemu jego historia w sekcjach Activity i Metrics zachowuje jego nazwę. Klucze, które nigdy nie były użyte, są usuwane całkowicie.
Otrzymasz wiadomość e-mail po usunięciu klucza.
Organization Keys and Billing
Użycie klucza należącego do organizacji wlicza się do planu właściciela organizacji, niezależnie od tego, kto wysłał request. Strona Usage & Limits właściciela zlicza te klucze obok jego kluczy osobistych i rozdziela obie kategorie.
Related
- Authentication: Jak klucze API współpracują z API
- Organizations: Role, członkowie i współdzielony dostęp
- Usage & Limits: Które klucze wliczają się do Twojego planu
- Dashboard Overview: Wszystkie sekcje panelu