Klucz API
Krótkie wyjaśnienie
Klucz API: Sekret lub token identyfikacyjny umożliwiający dostęp do interfejsu oprogramowania.
Znaczenie i zasada działania
Serwer weryfikuje klucz i stosuje skojarzone z nim uprawnienia. Klucz należy zachować w tajemnicy, ograniczyć jego uprawnienia i terminowo wymienić.
Zastosowania w biznesie
- Przykład biznesowy:
Usługa integracji wykorzystuje oddzielny klucz do pozyskiwania statystyk. Integracja powinna łączyć wydarzenie komunikacyjne z właściwym klientem, pracownikiem i procesem, bez tworzenia niepotrzebnych duplikatów.
Co sprawdzić przed wdrożeniem
Źródło prawdy danych, prawa dostępu, format pola, powtarzające się zdarzenia i zachowanie API w przypadku błędów są uzgadniane przed uruchomieniem. W przypadku „Klucza API” oznacza to, że parametry należy oceniać w kontekście rzeczywistego procesu biznesowego, a nie według nazwy opcji w ustawieniach.
Ograniczenia i typowe błędy
Nie publikuj kluczy prywatnych w publicznym JavaScript lub publicznym repozytorium. W praktyce sprawdzają nie tylko pomyślny transfer danych, ale także przywrócenie synchronizacji po awarii.