Przejdź do głównej zawartości

Uwierzytelnianie

API Saiku Cloud używa uwierzytelniania tokenem Bearer. Każde żądanie do https://api.saiku.bi/me/* niesie klucz API identyfikujący Twojego tenanta.

Adres bazowy

https://api.saiku.bi

Wydanie klucza API

  1. Otwórz stronę kluczy API z paska bocznego dashboardu.
  2. Nadaj kluczowi nazwę, która mówi, do czego służy — production-agent, staging-bot.
  3. Opcjonalnie wypisz dozwolone kostki, po przecinku, by zamknąć klucz tylko na nie. Zostaw puste, a klucz sięgnie każdej kostki w tenancie.
  4. Kliknij Utwórz.
  5. Skopiuj sekret natychmiast — pokazuje się raz. Potem dashboard trzyma już tylko nazwę i widoczny prefiks.

Wykonanie żądania

Wyślij klucz w nagłówku Authorization:

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

Poprawna odpowiedź:

{
"tenantId": "81e301f2-…",
"tenantSlug": "acme",
"tier": "team",
"connectionName": "production-warehouse"
}

Odkrywanie powierzchni

GET /me zwraca listę dostępnych dla Ciebie endpointów — mały indeks, który możesz odpytać najpierw, zamiast zaszywać ścieżki na sztywno:

{
"endpoints": [
"/me/tenant", "/me/tenant/deletion", "/me/upstream", "/me/limits",
"/me/cubes", "/me/analyze/cubes", "/me/members", "/me/workspaces",
"/me/api-keys", "/me/invites", "/me/audit", "/me/usage", "/me/schemas"
]
}

Limity żądań

Dwa kubełki — budżet przypływu na minutę i budżet ciągły na godzinę. Są per tenant, a nie per klucz, więc rozłożenie ruchu na kilka kluczy dzieli jeden budżet, zamiast go zwielokrotniać.

PoziomNa minutęNa godzinę
Starter601 000
Team30010 000
Business1 00050 000
EnterpriseIndywidualnieIndywidualnie

Nie zaszywaj tych liczb na sztywno — zapytaj. GET /me/limits mówi, co faktycznie obowiązuje dla Twojego klucza:

{ "enabled": true, "profile": "starter-default", "perMinute": 60, "perHour": 1000 }

Każda odpowiedź niesie Twój pozostały budżet, więc możesz przyhamować, zanim zostaniesz odrzucony, a nie po fakcie:

X-RateLimit-Remaining-Minute: 60
X-RateLimit-Remaining-Hour: 1000

Pilnowanie tych dwóch nagłówków to różnica między dobrze wychowaną integracją a taką, która odkrywa limit, waląc w niego. Gdy już w niego trafisz, dostajesz 429 Too Many Requests z nagłówkiem Retry-After mówiącym, kiedy wrócić.

Płacenie za to — 402 obejmuje niemal wszystko

Niemal cała powierzchnia /me/* wymaga aktywnej subskrypcji. „Aktywna” jest rozumiane hojnie — trialing i nawet past-due liczą się oba, więc odrzucona karta nie odcina Twojej integracji w środku ponawiania. Gdy subskrypcji naprawdę nie ma, każdy płatny endpoint odpowiada 402.

Cztery ścieżki zostają otwarte niezależnie od wszystkiego i są to te, które muszą:

ZwolnionaDlaczego
/me/billing/*Musisz w ogóle móc się zasubskrybować.
/me/tenantDashboard potrzebuje Twojej tożsamości, żeby się w ogóle wyrenderować.
/me/accountUsunięcie konta jest prawem bezwarunkowym, płatnym czy nie.
/me/invites/*Przyjęcie zaproszenia dzieje się, zanim masz płatnego tenanta.

Jeśli Twoja integracja zaczyna zwracać 402 na całej linii, to właśnie się stało — sprawdź GET /me/billing/state, a nie swój klucz.

Kształt odpowiedzi błędu

Każda odpowiedź błędu jest JSON-em:

{
"error": "payment_required",
"message": "This feature requires an active subscription or trial. Visit /billing to start your 14-day trial."
}

Częste kody błędów:

StatusKodZnaczenie
400różnieZłe żądanie. Kod nazywa konkretny problem — missing_workspace, invalid_bucket — a message mówi, czego oczekiwano.
401unauthorizedBrak klucza API albo klucz nieprawidłowy
402payment_requiredBrak aktywnej subskrypcji — co jest zwolnione, patrz wyżej
403forbiddenKlucz API prawidłowy, ale bez uprawnień do tego zasobu
404not_foundZasób nie istnieje albo nie jest widoczny dla Twojego tenanta
429rate_limitedPrzekroczony limit minutowy albo godzinowy

Rotacja klucza

  1. Na stronie kluczy API kliknij Utwórz klucz, by wydać nowy. Nadaj mu tę samą etykietę co klucz, który rotujesz.
  2. Przestaw swojego agenta / integrację na nowy klucz.
  3. Gdy potwierdzisz, że nowy klucz działa na produkcji, wróć na stronę kluczy API i unieważnij stary.

Nie ma przestoju — oba klucze są ważne jednocześnie, dopóki nie unieważnisz starego.

Co dalej

  • Użyj API rozliczeń, by zarządzać subskrypcją programowo.
  • Przeczytaj o izolacji tenantów, by zrozumieć, do czego klucz API może, a do czego nie może sięgnąć.