Saltearse al contenido

Autenticación

La API de Saiku Cloud usa autenticación con token Bearer. Cada petición a https://api.saiku.bi/me/* lleva una clave API que identifica su tenant.

URL base

https://api.saiku.bi

Emitir una clave API

  1. Abra la página de claves API desde la barra lateral del dashboard.
  2. Dele a la clave un nombre que diga para qué es — production-agent, staging-bot.
  3. Opcionalmente liste cubos permitidos, separados por comas, para confinar la clave solo a ésos. Déjelo en blanco y la clave alcanza todos los cubos del tenant.
  4. Pulse Crear.
  5. Copie el secreto de inmediato — se muestra una sola vez. Después el dashboard conserva solo el nombre y el prefijo visible.

Hacer una petición

Mande la clave en la cabecera Authorization:

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

Respuesta correcta:

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

Descubrir la superficie

GET /me devuelve la lista de endpoints disponibles para usted — un pequeño índice que puede consultar antes que codificar rutas a fuego:

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

Límites de tasa

Dos cubos — un presupuesto de ráfaga por minuto y uno sostenido por hora. Son por tenant, no por clave, así que repartir el tráfico entre varias claves comparte un presupuesto en vez de multiplicarlo.

NivelPor minutoPor hora
Starter601 000
Team30010 000
Business1 00050 000
EnterpriseA medidaA medida

No codifique esas cifras a fuego — pregunte. GET /me/limits le dice qué está realmente en vigor para su clave:

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

Cada respuesta lleva su presupuesto restante, así que puede retroceder antes de que le rechacen en vez de después:

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

Vigilar esas dos cabeceras es la diferencia entre una integración bien educada y otra que descubre el límite chocando con él. Cuando lo alcance, obtendrá 429 Too Many Requests con una cabecera Retry-After que dice cuándo volver.

Pagar por ello — el 402 cubre casi todo

Casi toda la superficie /me/* requiere una suscripción activa. «Activa» es generoso — trialing e incluso past-due cuentan ambos, así que una tarjeta que falla no corta su integración a mitad de un reintento. Cuando de verdad no hay suscripción, todo endpoint facturado responde 402.

Cuatro rutas quedan abiertas pase lo que pase, y son las que tienen que estarlo:

ExentaPor qué
/me/billing/*Tiene que poder suscribirse en primer lugar.
/me/tenantEl dashboard necesita su identidad para poder renderizar siquiera.
/me/accountBorrar su cuenta es un derecho incondicional, pague o no.
/me/invites/*Aceptar una invitación ocurre antes de tener un tenant de pago.

Si su integración empieza a devolver 402 de forma generalizada, es eso lo que pasó — mire GET /me/billing/state antes que su clave.

Forma de la respuesta de error

Toda respuesta de error es JSON:

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

Códigos de error comunes:

EstadoCódigoSignificado
400varíaPetición mal formada. El código nombra el problema concreto — missing_workspace, invalid_bucket — y message dice qué se esperaba.
401unauthorizedClave API ausente o inválida
402payment_requiredSin suscripción activa — vea arriba qué está exento
403forbiddenClave API válida pero sin permiso para este recurso
404not_foundEl recurso no existe, o no es visible para su tenant
429rate_limitedLímite por minuto o por hora superado

Rotar una clave

  1. En la página de claves API, pulse Crear clave para emitir una nueva. Dele la misma etiqueta que la clave que está rotando.
  2. Actualice su agente / integración para usar la clave nueva.
  3. Una vez confirmado que la nueva funciona en producción, vuelva a la página de claves API y revoque la vieja.

No hay tiempo de caída — ambas claves son válidas a la vez hasta que revoca la vieja.

Qué sigue