Generowanie klucza API

Klucz API umożliwia integrację platformy Welyo z zewnętrznymi systemami oraz korzystanie z dostępnych funkcji API. W tym artykule opisujemy, jak wygenerować nowy klucz API oraz na co zwrócić uwagę podczas jego zmiany.

Jak wygenerować klucz API

1. Zaloguj się do platformy Welyo jako administrator.
2. Przejdź do sekcji: Administracja > Integracje > Klucz API.

3. W oknie Klucz API kliknij przycisk Generuj klucz.

   

4. Skopiuj wygenerowany klucz i zapisz go w bezpiecznym miejscu.

Bezpieczeństwo klucza API

Klucz API należy traktować jak hasło dostępu do systemu.

• Nie udostępniaj klucza API osobom nieuprawnionym ani w publicznych miejscach (np. w wiadomościach e-mail, dokumentacji dostępnej publicznie lub repozytoriach kodu).
• Osoba posiadająca klucz API może uzyskać dostęp do funkcji API i wykonywać operacje w systemie w imieniu Twojej platformy, co może prowadzić do nieautoryzowanych zmian lub dostępu do danych.

Jeśli istnieje podejrzenie, że klucz API został ujawniony, należy jak najszybciej wygenerować nowy klucz i zaktualizować go we wszystkich integracjach.

Ważność klucza API

Klucz API jest ważny przez 5 lat od momentu wygenerowania.

Na 7 dni przed jego wygaśnięciem system automatycznie wysyła powiadomienie e-mail do administratorów platformy Welyo z informacją o konieczności wygenerowania nowego klucza i zaktualizowania go w używanych integracjach.

Ważne informacje

• Jeśli posiadasz już wygenerowany klucz API i jest on wykorzystywany w skonfigurowanych integracjach, wygenerowanie nowego klucza spowoduje unieważnienie poprzedniego.
• W takiej sytuacji może nastąpić utrata połączenia pomiędzy zintegrowanymi systemami, dlatego konieczne będzie zaktualizowanie klucza API w każdej konfiguracji integracji, aby przywrócić ich działanie.
• Nie ma możliwości przywrócenia poprzedniego klucza API po wygenerowaniu nowego.