Przejdź do głównej zawartości

Klucze API

Klucze API to miejsce, gdzie generujesz tokeny Bearer, których agenci, integracje i własne dashboardy używają do wywoływania api.saiku.bi. Trafisz tu raz na każdą integrację, którą chcesz ustawić, i okresowo potem dla rotacji.

Strona listuje każdy klucz w Twoim tenancie z etykietą, częściowym ID klucza, twórcą, datą utworzenia i znacznikiem ostatniego użycia, który aktualizuje się niemal w czasie rzeczywistym. Przydatne, by wyłapać klucze, które już nie są używane (unieważnij je), i klucze, które są używane intensywnie (właściwi kandydaci do przeglądu rotacji).

Generowanie klucza

  1. Kliknij Utwórz klucz i nadaj etykietę. Użyj nazwy opisującej, do czego służy: production-billing-agent, staging-bot, client-acme-integration. Etykiety pojawiają się w dzienniku audytu, więc niech będą rozpoznawalne.

  2. Kliknij Utwórz.

  3. Skopiuj sekret natychmiast. Pokazuje się tylko raz. Dashboard po tym momencie trzyma ID klucza i etykietę, ale sam sekret nie jest już do odzyskania — nie przechowujemy go w odwracalnej formie.

  4. Wklej do store’a sekretów Twojej integracji. Przetestuj end-to-end.

Używanie klucza

Wyślij sekret w nagłówku Authorization:

Okno terminala
curl https://api.saiku.bi/me/tenant \
-H "Authorization: Bearer sk_…"

Pełna referencja mieszka w Uwierzytelnianiu — bazowy URL, limity szybkości, kształt błędów, wszystko.

Rotacja

Czysta rotacja ma zero przestoju, bo oba klucze są ważne podczas przełączenia.

  1. Utwórz nowy klucz z tą samą etykietą co stary (dopisz -v2, -v3, żeby je rozróżnić).
  2. Wdroż nowy klucz do Twojej integracji.
  3. Potwierdź, że nowy klucz jest używany — kolumna Ostatnio użyte na stronie aktualizuje się w ciągu minuty lub dwóch.
  4. Unieważnij stary klucz, gdy jesteś pewien.

Unieważnianie

Ikona kosza w wierszu, potwierdź. Klucz jest unieważniony natychmiast — następne żądanie używające go dostaje 401 Unauthorized. Nie ma okresu łaski ani cofnięcia, więc unieważniaj świadomie.

Jeden klucz na integrację

Nawyk, który się opłaca: jeden klucz na każdą rzecz, która Cię woła. Jeśli agent zostanie skompromitowany, unieważniasz jego klucz i nic poza tym się nie zmienia. Gdy chcesz wiedzieć, która integracja wykonała konkretne żądanie, kolumna klucza w dzienniku audytu odpowiada bez pracy detektywistycznej. A gdy zakres partnera trzeba zawęzić, edytujesz jedną listę dozwolonych zamiast audytować współdzielone poświadczenie.

Klucze wydaje się za darmo, więc jedynym realnym kosztem jest nieco dłuższa tabela.

Powiązane