Klucze API

Zarządzanie kluczami API w ProcessMind

Aby zintegrować aplikację z API ProcessMind, należy utworzyć klucze API i nimi zarządzać. Dowiedz się, jak je generować, używać i zabezpieczać.

W ustawieniach konta ProcessMind przejdź do sekcji „Klucze API”. Aby utworzyć nowy klucz API, kliknij przycisk Nowy klucz API środowiska. Nadaj kluczowi nazwę, która ułatwi jego późniejszą identyfikację.

Tworzenie klucza API

Można utworzyć kilka kluczy API dla różnych aplikacji lub usług. Każdym kluczem można zarządzać niezależnie. W razie potrzeby można go unieważnić bez wpływu na pozostałe integracje. Po wygenerowaniu klucza należy go skopiować i bezpiecznie przechować. Ze względów bezpieczeństwa klucz jest wyświetlany tylko raz, podczas tworzenia.

Klucze API organizacji

Administratorzy organizacji mogą też tworzyć klucze API organizacji na tej samej stronie. W przeciwieństwie do kluczy środowiskowych klucz organizacji działa we wszystkich środowiskach (tenantach) organizacji, dzięki czemu jedna integracja może obsługiwać każde z nich. Klucze organizacji służą do:

• Tworzenia kluczy API dla środowisk: tworzenia, aktualizowania i usuwania kluczy przypisanych do tenantów za pomocą External API (/v1/tenant/{tenantId}/api-keys).
• Generowania jednorazowych linków logowania: przekierowania użytkownika z własnego produktu bezpośrednio do ProcessMind, już po uwierzytelnieniu (/v1/tenant/{tenantId}/users/{userId}/login-token).

Zakresy uprawnień

Zakres sessions należy włączać tylko dla kluczy używanych do przekazania logowania. Takie klucze należy chronić jak hasła: wygenerowany token loguje użytkownika bez pytania o hasło. Klucz organizacji może generować tokeny dla użytkowników ze wszystkich środowisk organizacji, a klucz środowiskowy tylko dla użytkowników przypisanego do niego środowiska.

Jednorazowe przekazanie logowania

POST /v1/tenant/{tenantId}/users/{userId}/login-tokenzwraca jednorazowy token (ważny przez 60 sekund), powiązany z użytkownikiem, środowiskiem i organizacją, oraz url. Przeglądarkę użytkownika należy przekierować pod ten adres URL. Użytkownik trafi do ProcessMind z własną sesją, bez linku e-mail i bez podszywania się pod inną osobę. W treści żądania można opcjonalnie przekazać path, aby otworzyć konkretną stronę. Klucz musi mieć zakres sessions, a token można wygenerować tylko dla użytkownika tenanta, którego obsługę dopuszcza dany klucz.

Każde wygenerowanie tokenu jest rejestrowane w dzienniku audytowym, podlega ścisłym limitom częstotliwości i zostaje natychmiast zablokowane po wyłączeniu klucza lub utracie dostępu przez użytkownika. Token jest zwracany tylko raz i nigdy nie trafia do logów.

Powiązane tematy

• Omówienie API: wykonywanie wywołań API.
• Dokumentacja API: dokumentacja endpointów.