Aller au contenu

Authentification

L’API Saiku Cloud utilise l’authentification par jeton Bearer. Chaque requête vers https://api.saiku.bi/me/* porte une clé API qui identifie votre tenant.

URL de base

https://api.saiku.bi

Émettre une clé API

  1. Ouvrez la page Clés API depuis la barre latérale du dashboard.
  2. Donnez à la clé un nom qui dit à quoi elle sert — production-agent, staging-bot.
  3. Listez éventuellement des cubes autorisés, séparés par des virgules, pour confiner la clé à ceux-là. Laissez vide et la clé atteint tous les cubes du tenant.
  4. Cliquez sur Créer.
  5. Copiez le secret immédiatement — il n’est affiché qu’une fois. Ensuite le dashboard ne garde que le nom et le préfixe visible.

Faire une requête

Envoyez la clé dans l’en-tête Authorization :

Fenêtre de terminal
curl https://api.saiku.bi/me/tenant \
-H "Authorization: Bearer sk_abc123…"

Réponse en cas de succès :

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

Découvrir la surface

GET /me renvoie la liste des points d’entrée qui vous sont disponibles — un petit index à interroger d’abord plutôt que de coder les chemins en dur :

{
"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"
]
}

Limites de débit

Deux seaux — un budget de rafale par minute et un budget soutenu par heure. Ils sont par tenant, pas par clé : répartir le trafic sur plusieurs clés partage un seul budget au lieu de le multiplier.

PalierPar minutePar heure
Starter601 000
Team30010 000
Business1 00050 000
EnterpriseSur mesureSur mesure

Ne codez pas ces chiffres en dur — demandez. GET /me/limits vous dit ce qui s’applique réellement à votre clé :

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

Chaque réponse porte votre budget restant, vous pouvez donc lever le pied avant d’être refusé plutôt qu’après :

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

Surveiller ces deux en-têtes fait la différence entre une intégration bien élevée et une qui découvre la limite en la percutant. Quand vous la touchez malgré tout, vous recevez 429 Too Many Requests avec un en-tête Retry-After indiquant quand revenir.

Le payer — le 402 couvre presque tout

Presque toute la surface /me/* exige un abonnement actif. « Actif » est généreux — trialing et même past-due comptent tous les deux, une carte en échec ne coupe donc pas votre intégration en plein réessai. Quand il n’y a réellement plus d’abonnement, chaque point d’entrée facturé répond 402.

Quatre chemins restent ouverts quoi qu’il arrive, et ce sont ceux qui doivent l’être :

ExemptéPourquoi
/me/billing/*Il faut bien pouvoir s’abonner au départ.
/me/tenantLe dashboard a besoin de votre identité ne serait-ce que pour s’afficher.
/me/accountSupprimer votre compte est un droit inconditionnel, payant ou non.
/me/invites/*Accepter une invitation se produit avant d’avoir un tenant payant.

Si votre intégration se met à renvoyer 402 sur toute la ligne, c’est ce qui s’est produit — regardez GET /me/billing/state plutôt que votre clé.

Forme de la réponse d’erreur

Toute réponse d’erreur est du JSON :

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

Codes d’erreur courants :

StatutCodeSignification
400variableRequête incorrecte. Le code nomme le problème précis — missing_workspace, invalid_bucket — et message dit ce qui était attendu.
401unauthorizedClé API absente ou invalide
402payment_requiredPas d’abonnement actif — voir plus haut ce qui est exempté
403forbiddenClé API valide mais sans permission sur cette ressource
404not_foundLa ressource n’existe pas, ou n’est pas visible pour votre tenant
429rate_limitedLimite par minute ou par heure dépassée

Faire tourner une clé

  1. Sur la page Clés API, cliquez sur Créer une clé pour en émettre une nouvelle. Donnez-lui le même libellé que celle que vous remplacez.
  2. Mettez votre agent / intégration à jour pour utiliser la nouvelle clé.
  3. Une fois confirmé que la nouvelle fonctionne en production, retournez sur la page Clés API et révoquez l’ancienne.

Il n’y a pas d’interruption — les deux clés sont valides en même temps jusqu’à ce que vous révoquiez l’ancienne.

La suite