Uwierzytelnianie i klucze API
Utwórz klucz API, wybierz jego uprawnienia i termin ważności oraz uwierzytelniaj swoje zapytania.
Każde zapytanie do API uwierzytelnia się tokenem bearer:
curl "https://europe-central2-mailingr-54736.cloudfunctions.net/api-v1/products" \
-H "Authorization: Bearer YOUR_API_KEY"Klucz identyfikuje zarówno Ciebie, jak i Twój workspace — nie przekazuje się osobnego id workspace'u.
Utwórz klucz API
Otwórz klucze API w panelu
W panelu Zanfii przejdź do Integracje → API, MCP i CLI i kliknij Utwórz nowy klucz API.
Nazwij klucz i wybierz termin ważności
Nadaj kluczowi nazwę, która wskazuje, do jakiej integracji służy. Klucze domyślnie wygasają po 365 dniach; możesz wybrać krótszy okres albo — dla długo działających integracji serwerowych — klucz bezterminowy.
Nadaj uprawnienia
Określ, co klucz może robić, per zasób: Odczyt i/lub Zapis dla Produktów, Społeczności i Stron. Nadawaj najmniejszy zakres, jakiego integracja potrzebuje — w razie potrzeby zawsze możesz później utworzyć kolejny klucz z szerszymi uprawnieniami.
Skopiuj klucz od razu
Klucz jest pokazywany tylko raz, zaraz po utworzeniu. Zapisz go w menedżerze sekretów lub zmiennej środowiskowej — po zamknięciu okna nie da się go już odczytać, można go jedynie unieważnić.
Uprawnienia (scope'y)
| Scope | Daje dostęp do |
|---|---|
products:read / products:write | Produkty, ceny, oferty, order bumpy, kursy, media, klienci, zamówienia, statystyki, rabaty |
communities:read / communities:write | Kanały społeczności, posty, komentarze, czat |
pages:read / pages:write | Własne strony hostowane oraz strona główna sklepu |
Zapytanie wykraczające poza zakres uprawnień (scope) klucza kończy się błędem 403 z powodem insufficient-scope.
Cykl życia klucza
- Unieważnij klucz w dowolnym momencie w Integracje → API, MCP i CLI — unieważnienie działa natychmiast.
- Wygasłe klucze przestają działać automatycznie i są oznaczone jako Wygasły na liście kluczy.
- Klucze oznaczone tagiem CLI zostały utworzone przez
zanfia login— CLI zarządza nimi automatycznie (klucz jest tworzony na nowo przy każdym logowaniu, ważny 90 dni) i nie musisz ich dotykać.
Traktuj klucze jak hasła
Każdy, kto ma klucz, może działać w Twoim workspace w granicach jego scope'ów. Nigdy nie commituj kluczy do repozytorium ani nie osadzaj ich w kodzie po stronie klienta — klucze API należą na serwery, do sekretów CI albo do środowiska Twojego terminala.
Zweryfikuj klucz
Wywołaj endpoint tożsamości, aby potwierdzić, że klucz działa, i sprawdzić, do którego workspace'u należy. Ten przykład pokazuje pełen zestaw generowanych języków klienckich — strony dokumentacji poszczególnych zasobów ograniczają się do cURL i JavaScriptu:
/workspaceAuthorization
bearerAuth API key from Dashboard → Integrations → API, MCP and CLI.
In: header
Response Body
application/json
application/json
curl -X GET "https://example.com/workspace"{ "workspaceId": "string", "workspaceName": "string", "userEmail": "string", "scopes": [ "string" ]}{ "error": "string"}Klucze członkowskie (Community API)
Członkowie Twojej społeczności mogą tworzyć własne klucze o zakresie członkowskim z poziomu platformy społeczności (Ustawienia → Deweloper w portalu członka). Klucze członkowskie działają wyłącznie z Community API i występują w imieniu danego członka — nie mają dostępu do zasobów workspace'u. W ten sposób członkowie podłączają asystentów AI do społeczności, do których należą.
Czy ten artykuł był pomocny?