Sekrety i klucze API

Sekrety to zaszyfrowany sejf firmy na klucze API i tokeny używane przez obiegi. Obieg zna tylko nazwę sekretu, wartość zostaje na serwerze, a sekret może wyjść wyłącznie przez HTTPS na hosty, które wskażesz.

Opublikowano
Zaktualizowano
Wersja systemu26.44
Czas czytania5 min
Na tej stronieJak działa sejfDodawanie sekretuUżycie sekretu w obieguZmiana i usuwanieUprawnieniaBitee AI

Gdy obieg łączy się z zewnętrznym systemem (CRM, kurier, system księgowy, własne API), potrzebuje klucza. Klucza nie wpisuj w akcję obiegu: zapisz go w Sekretach i odwołaj się do niego nazwą, np. {{secret:CRM_TOKEN}}. Dzięki temu klucz nie leży jawnie w definicji obiegu, w jego historii, w dzienniku zdarzeń, w kolejce zadań ani w tym, co widzi Bitee AI.

Lista sekretów firmy

Jak działa sejf#

CechaCo to znaczy w praktyce
Tylko zapisPo zapisaniu nikt nie odczyta wartości, także administrator. Panel pokazuje jedynie końcówkę długich kluczy (np. …b202), żeby rozpoznać, który to klucz. Wartość można tylko zastąpić nową
SzyfrowanieWartość jest szyfrowana kluczem platformy (AES-256-GCM) przed zapisem do bazy
Przypięcie do hostówKażdy sekret ma listę hostów, na które wolno go wysłać. Obieg, który spróbuje wysłać go gdzie indziej, zatrzyma się z błędem, nawet jeśli ktoś podmieni adres w akcji
Tylko HTTPSSekret nigdy nie wychodzi zwykłym http://
Bez śladówWartość nie trafia do historii obiegu, dziennika zdarzeń, kolejki, komunikatów błędów ani do Bitee AI. Jeśli zewnętrzne API odeśle klucz w odpowiedzi, jest on wycinany, zanim odpowiedź trafi do zmiennych
Osobno dla każdej firmySekrety jednej firmy są niewidoczne dla innych firm na platformie

Dodawanie sekretu#

Okno dodawania sekretu
Nowy sekret krok po kroku
  1. Kliknij Dodaj sekret.
  2. Nazwa (referencja w obiegu): wielkie litery, cyfry i podkreślnik, zaczyna się od litery, np. CRM_TOKEN, KURIER_API_KEY. Pod polem od razu widzisz gotową referencję, np. {{secret:CRM_TOKEN}}. Nazwy nie da się później zmienić, bo odwołują się do niej obiegi.
  3. Wartość: wklej klucz z systemu zewnętrznego. Pole odrzuca spacje na początku i końcu oraz znaki nowej linii, bo to prawie zawsze błąd wklejenia.
  4. Hosty, na które wolno wysłać sekret: jeden na linię, bez https:// i bez ścieżki, np. api.mojcrm.pl albo *.kurier-przyklad.pl dla wszystkich subdomen. Zbyt szerokie wzorce (np. *.com.pl) są odrzucane.
  5. Opis (opcjonalnie): do czego służy klucz, np. „Token API konta produkcyjnego”.
  6. Kliknij Zapisz.

Użycie sekretu w obiegu#

Sekret wstawiasz w akcji Wywołanie REST API na dwa sposoby:

  • Wybór z listy: przy polu wartości (np. Token w zakładce Auth) kliknij przycisk (x) i wybierz kategorię Sekrety firmy. Lista pokazuje nazwy sekretów i hosty, na które wolno je wysłać.
  • Wpisanie referencji: w nagłówku, parametrze adresu albo treści wpisz {{secret:NAZWA}}, np. nagłówek Authorization z wartością Bearer {{secret:CRM_TOKEN}}.
Wybór sekretu w edytorze REST
Token z sekretu w zakładce Auth
Gdzie w akcjiDozwoloneUwagi
Zakładka Auth (Bearer, Basic, klucz API)takNajprostsza droga. Prefiks Bearer dokleja system
Headers (nagłówki)takNp. X-Api-Key: {{secret:KURIER_API_KEY}}
Params (parametry adresu)takWartość jest kodowana do adresu
Body (treść JSON)takWartość jest poprawnie escapowana w JSON
Host albo ścieżka adresunieSekret zmieniałby adres docelowy, więc obieg go odrzuci

Zmiana i usuwanie#

  • Zmień zastępuje wartość nową (rotacja klucza). Obiegi działają dalej bez edycji, bo odwołują się do nazwy. Możesz też poprawić hosty i opis.
  • Ikona kosza usuwa sekret. Obiegi, które go używają, zatrzymają się z błędem „sekret nie istnieje”. Wartości nie da się odzyskać.
  • Lista pokazuje ostatnią zmianę wartości i ostatnie użycie przez obieg, dzięki czemu łatwo znaleźć klucze, których nic już nie używa.

Uprawnienia#

Dostęp nadajesz w rolach i uprawnieniach na module Integracje → Sekrety i klucze API: widoczność i odczyt listy, dodawanie, zmiana, usuwanie. Moduł pojawia się w menu dopiero, gdy rola ma do niego prawo widoczności. Osoba, która tylko buduje obiegi, nie potrzebuje dostępu do Sekretów: lista nazw w edytorze obiegu jest dostępna z samym prawem do obiegów, a wartości i tak nikt nie widzi.

Bitee AI#

Asystent Bitee AI wie, jak działa sejf. Zapytany o integrację z kluczem API, pokieruje do Integracje → Sekrety i podpowie referencję {{secret:NAZWA}}. Budując obieg w edytorze, sprawdza nazwy dostępnych sekretów (bez wartości) i wstawia je do akcji REST. Nie poprosi o wklejenie klucza do czatu.

PodsumowanieW skrócie

Klucz zapisujesz raz w Sekretach, z listą hostów. W obiegu używasz nazwy: z listy „Sekrety firmy” albo jako {{secret:NAZWA}}. Wartości nie widzi nikt, nie trafia do logów ani do AI i wychodzi tylko przez HTTPS na wskazane hosty.