Skip to main content
Klucze API uwierzytelniają żądania kierowane do Public API /v1. Każdy klucz należy do konta usługi i jest tworzony na stronie szczegółów tego konta w Developer Hub. Klucza API z ograniczonym zakresem uprawnień należy używać w prywatnych Integracjach backendowych, gdy bezpieczne przechowywanie i rotacja sekretu spełniają Państwa wymagania. Nie jest potrzebny klient OAuth ani wymiana tokenów. Jeśli Państwa organizacja wymaga krótkotrwałych tokenów dostępu OAuth, zapoznaj się z sekcją Uwierzytelnianie.

​
Budowa klucza

  • Identyfikator — zaczyna się od ak_. Można go bezpiecznie podawać w zgłoszeniach, dziennikach i konfiguracji; sam w sobie niczego nie uprawnia.
  • Sekret — zaczyna się od lsk_live_. To poświadczenie, które przedstawia Państwa integracja. Jest wyświetlany tylko raz, podczas tworzenia lub rotacji, i nie można go później odzyskać. Lista kluczy pokazuje tylko ostatnie cztery znaki (na przykład lsk_live_…xQc4), dzięki czemu można dopasować wiersz do poświadczenia używanego przez wywołującego.
  • Uprawnienia — podzbiór uprawnień konta usługi, do którego należy klucz, wybierany podczas tworzenia. Klucz nigdy nie może robić więcej, niż pozwala jego konto.
  • Wygaśnięcie — pole obowiązkowe. Każdy klucz ma datę ważności.
Sekrety należy zapisać w menedżerze sekretów od razu po ich wyświetleniu. Nigdy nie należy umieszczać ich w systemie kontroli wersji, osadzać w kodzie po stronie klienta ani udostępniać na czacie. Każdy, kto zna sekret, może działać z uprawnieniami danego klucza.

​
Tworzenie klucza

Na stronie szczegółów konta usługi klucz tworzy się w czterech krokach: nadaj mu nazwę, wybierz uprawnienia potrzebne temu konkretnemu kluczowi, wybierz okres ważności — 30, 90 lub 365 dni albo okres niestandardowy do jednego roku — a następnie sprawdź dane. Sekret zostanie wyświetlony po zakończeniu, tylko raz. Zakres każdego klucza należy ograniczyć do najwęższego zestawu uprawnień, jakiego potrzebuje wywołujący, nawet jeśli konto pozwala na więcej. Jeśli klucz wycieknie, jego uprawnienia wyznaczają zasięg potencjalnych szkód.

​
Rotacja bez przestojów

Rotacja generuje nowy sekret i rozpoczyna okres nakładania się — 1 godzinę, 24 godziny lub 7 dni — w którym stary sekret nadal działa. Dzięki temu nowy sekret można wdrażać we własnym tempie:
1

Wykonaj rotację klucza

Wybierz okres nakładania się, który obejmie Państwa najwolniejszą ścieżkę wdrożenia. Nowy sekret jest wyświetlany tylko raz — zapisz go natychmiast.
2

Zaktualizuj swoje Integracje

Zastąp stary sekret wszędzie tam, gdzie jest skonfigurowany. Status klucza pokazuje okres nakładania się do jego zakończenia.
3

Zweryfikuj przed zakończeniem okresu

Skorzystaj z dzienników żądań, aby potwierdzić, że ruch został przeniesiony na nowy sekret. Po zakończeniu okresu nakładania się stary sekret przestaje uwierzytelniać.
Rotację warto wykonać także przed wygaśnięciem: klucze zbliżające się do daty ważności są oznaczane na liście kluczy jako wygasające. Wygasły klucz przestaje uwierzytelniać — żądania z jego użyciem zwracają 401 z kodem credential_expired.

​
Natychmiastowe unieważnienie

Unieważnienie działa natychmiast i jest nieodwracalne — nie ma okresu nakładania się ani możliwości cofnięcia. Klucz należy unieważnić, gdy tylko pojawi się podejrzenie, że jego sekret został ujawniony; rotację należy natomiast stosować, gdy wymieniają Państwo sprawne poświadczenie. Żądania wykonane z użyciem unieważnionego klucza zwracają 401 z kodem credential_revoked. Jeśli chcą Państwo jednocześnie zatrzymać wszystkie klucze używane przez integrację, wyłączcie zamiast tego jej konto usługi.