Klucze API
Klucze API tworzy się w Ustawienia > API. Każdy klucz ma format:
clrf_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Klucz jest wyświetlany tylko raz w momencie tworzenia. Skopiuj go i przechowuj bezpiecznie.
Uwierzytelnianie zapytań
Przekaż klucz w nagłówku Authorization z prefiksem Bearer:
curl https://my.clarife.app/api/v1/documents \
-H "Authorization: Bearer clrf_xxxxx"
Kontekst workspace
Jeśli pracujesz w zespole, dodaj nagłówek X-Workspace-Id, aby operacje wykonywały się w kontekście workspace:
curl https://my.clarife.app/api/v1/documents \
-H "Authorization: Bearer clrf_xxxxx" \
-H "X-Workspace-Id: a1b2c3d4-e5f6-7890-abcd-ef1234567890"
Bez nagłówka X-Workspace-Id API operuje na prywatnych zasobach użytkownika.
Scopy (uprawnienia)
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 |
Nadawaj kluczom tylko te scopy, których faktycznie potrzebują. Stosuj zasadę najmniejszych uprawnień.
Wygasanie i odwoływanie kluczy
- 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.
- Klucz widoczny jest w interfejsie tylko jako
clrf_xxxx...xxxx (pierwsze i ostatnie 4 znaki).
Limity kluczy
| Plan | Maksymalna liczba kluczy |
|---|
| Pro | 5 |
| Business | 20 |
Odpowiedzi błędów uwierzytelniania
| 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ń |
