Uwierzytelnianie

Klucze API

Klucze API tworzy się w Ustawienia > API. Każdy klucz składa się z prefiksu clrf_ i 64 znaków szesnastkowych:

clrf_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

⚠️ Uwaga: Klucz jest wyświetlany tylko raz w momencie tworzenia. Skopiuj go i przechowuj bezpiecznie.

Przekaż klucz w nagłówku Authorization z prefiksem Bearer:

bash

curl https://my.clarife.app/api/v1/documents \
  -H "Authorization: Bearer clrf_xxxxx"

Jeśli pracujesz w zespole, dodaj nagłówek X-Workspace-Id, aby operacje wykonywały się w kontekście workspace:

bash

curl https://my.clarife.app/api/v1/documents \
  -H "Authorization: Bearer clrf_xxxxx" \
  -H "X-Workspace-Id: a1b2c3d4-e5f6-7890-abcd-ef1234567890"

ℹ️ Informacja: Bez nagłówka X-Workspace-Id API operuje na prywatnych zasobach użytkownika.

Każdy klucz API ma przypisane scopy, które kontrolują dostęp do poszczególnych zasobów.

Scope	Opis
documents:read	Odczyt dokumentów (lista, szczegóły, content)
documents:write	Tworzenie, edycja i usuwanie dokumentów
projects:read	Odczyt projektów i folderów
projects:write	Tworzenie, edycja i usuwanie projektów/folderów
shares:read	Odczyt linków udostępniania
shares:write	Tworzenie, edycja i usuwanie linków
brandings:read	Odczyt brandingów (plan Business)
media:write	Upload obrazów do dokumentów
workspace:read	Odczyt informacji o workspace i członkach
kb:read	Odczyt Baz Wiedzy, kategorii i wpisów (plan Business)
kb:write	Zarządzanie treścią i ustawieniami Baz Wiedzy (plan Business)

💡 Wskazówka: Nadawaj kluczom tylko te scopy, których faktycznie potrzebują. Stosuj zasadę najmniejszych uprawnień.

Klucze nie wygasają automatycznie - są ważne do momentu usunięcia.
Aby odwołać klucz, przejdź do Ustawienia > API i kliknij Usuń przy wybranym kluczu.
Usunięty klucz przestaje działać natychmiast.
W interfejsie klucz jest widoczny tylko po prefiksie - pierwszych 8 znakach jego losowej części.

Plan	Maksymalna liczba kluczy
Pro	5
Business	20

Status HTTP	Kod	Opis
401	UNAUTHORIZED	Brak nagłówka Authorization lub nieprawidłowy klucz
403	INSUFFICIENT_SCOPE	Klucz nie ma wymaganego scope
403	PLAN_REQUIRED	Funkcja wymaga wyższego planu
429	RATE_LIMITED	Przekroczono limit zapytań