Klucze API

Generuj klucze API i zarządzaj nimi, aby uzyskać programowy dostęp.

Klucze API umożliwiają programowy dostęp do Twoich agentów. Używaj ich, aby zintegrować Agentkit z własnymi aplikacjami lub połączyć usługi zewnętrzne.

Tworzenie kluczy i korzystanie z API wymaga planu Hobby lub wyższego z aktywnymi rozliczeniami. Członkowie obszaru roboczego mogą nadal przeglądać i unieważniać istniejące klucze po utracie tego uprawnienia. Ulepsz swój plan →

Tworzenie klucza API

Przejdź do swojego obszaru roboczego
Kliknij Klucze API na pasku bocznym
Kliknij Utwórz klucz API
Potwierdź w oknie dialogowym

Nowy klucz pojawi się na liście i w każdej chwili można go odsłonić lub skopiować.

Wyświetlanie i kopiowanie kluczy

Każdy klucz na liście jest domyślnie zamaskowany. Użyj ikony oka, aby odsłonić klucz, oraz ikony kopiowania, aby skopiować go do schowka.

Korzystanie z kluczy API

Dołącz klucz do żądań API:

curl -X POST 'https://your-domain.com/api/v1/chat' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{"chatbotId": "uuid", "messages": [{"role": "user", "content": "Hello"}]}'

Pełna dokumentacja API →

Zarządzanie kluczami

Wyświetlanie wszystkich kluczy

Wszystkie klucze danego obszaru roboczego są widoczne na stronie Klucze API.

Usuwanie klucza

Znajdź klucz na liście
Kliknij ikonę kosza
Potwierdź usunięcie

Usunięte klucze przestają działać natychmiast.

Unieważnianie kluczy po wygaśnięciu dostępu

Jeśli obszar roboczy utraci dostęp do API, zaloguj się i usuń zbędne klucze na stronie Klucze API. Aby je unieważnić, nie musisz odnawiać rozliczeń. Nadal musisz być członkiem obszaru roboczego. Jeśli masz włączone MFA, ukończ weryfikację MFA przed zarządzaniem kluczami. Do tego czasu baza danych ukrywa klucze obszaru roboczego i odmawia ich usunięcia. Nie przywraca to możliwości korzystania z API ani uprawnienia do tworzenia kluczy.

Wcześniej Agentkit sprawdzał płatne uprawnienie do API przed usunięciem klucza. Zasady bazy danych również wymagały tego uprawnienia do odczytu lub usuwania kluczy. Utrata dostępu mogła więc blokować usunięcie istniejącego poświadczenia.

Poprawka oddziela tworzenie od usuwania. Członkostwo w obszarze roboczym określa dostęp do odczytu i usuwania istniejących kluczy, a osobna zasada bazy danych egzekwuje MFA. Tworzenie i aktualizacja kluczy nadal wymagają uprawnienia do API. Operacja usuwania dopasowuje zarówno ID klucza, jak i ID obszaru roboczego i zgłasza sukces tylko wtedy, gdy baza danych zwróci usunięty wiersz.

Ten uproszczony przykład opisuje zmianę warunku dostępu:

Before
  Require API entitlement before deleting an existing key.

After
  Delete only a key belonging to the requested workspace.
  Require a returned deleted row before reporting success.
  Keep membership checks and enforce MFA in the database.

Testy aplikacji symulują klienta bazy danych. Sprawdzają filtry i obsługę wyników, a nie zasady bazy danych. Testy SQL używają syntetycznych kont i wycofują zmiany. Oczekiwane wyniki obejmują:

Sprawdzenie	Warstwa testu	Oczekiwany wynik
Uprawniony członek unieważnia bez uprawnienia do API	Symulacja aplikacji	Brak zapytania o uprawnienie; filtry klucza i obszaru roboczego; sukces wymaga zwróconego wiersza
Uprawniony członek unieważnia bez uprawnienia do API	SQL	Jeden klucz własnego obszaru roboczego usunięty
Członek tworzy klucz bez uprawnienia	Symulacja aplikacji i SQL	Odrzucono
Członek próbuje usunąć klucz innego obszaru roboczego	SQL	Brak usuniętych wierszy
Wymagane MFA nie jest spełnione	SQL	Brak usuniętych wierszy
Żądany klucz nie istnieje lub jest niewidoczny dla wywołującego	Symulacja aplikacji	Operacja zgłasza błąd

Są to oczekiwania testów regresji, a nie wyniki próby produkcyjnej. Zastosuj ten sam wzorzec do tymczasowych poświadczeń w przepływach agentów. Zmień dostęp przed sprzątaniem, a następnie sprawdź, czy uprawnione usuwanie się powiodło, a nieuprawnione zostało odrzucone.

Najlepsze praktyki bezpieczeństwa

Nigdy nie ujawniaj kluczy

Nie umieszczaj kluczy w commitach repozytoriów git
Nie umieszczaj kluczy w kodzie po stronie klienta
Korzystaj ze zmiennych środowiskowych

Regularnie rotuj klucze

Twórz nowe klucze cyklicznie
Aktualizuj swoje aplikacje
Usuwaj stare klucze

Używaj oddzielnych kluczy

Twórz osobne klucze dla:

Środowiska produkcyjnego i deweloperskiego
Różnych aplikacji
Różnych członków zespołu lub usług

Zakres uprawnień klucza

Klucze API są przypisane do obszaru roboczego, w którym zostały utworzone, i mają dostęp do:

Wszystkich agentów w obszarze roboczym
Punktów końcowych API czatu
Zarządzania webhookami

Klucze nie mogą:

Zarządzać członkami zespołu
Uzyskać dostępu do rozliczeń
Tworzyć innych kluczy API

Połączenie z Zapier

Podczas łączenia z Zapier:

Utwórz dedykowany klucz API dla Zapier
Użyj tego klucza w połączeniu z Zapier
Nie używaj tego klucza do innych celów

Skonfiguruj Zapier →

Rozwiązywanie problemów

Błąd „Invalid API key”

Sprawdź, czy klucz został poprawnie skopiowany
Sprawdź, czy nie ma spacji na początku lub końcu
Upewnij się, że klucz nie został usunięty

Błąd „Key not authorized”

Upewnij się, że agent należy do Twojego obszaru roboczego
Sprawdź, czy obszar roboczy klucza się zgadza
W przypadku żądań API upewnij się, że Twój obszar roboczy korzysta z planu Hobby lub wyższego z aktywnymi rozliczeniami

Klucz nie działa po utworzeniu

Spróbuj odświeżyć stronę
Odczekaj 30 sekund na propagację
Jeśli problem nadal występuje, utwórz nowy klucz