Zum Inhalt springen
Saiku Cloud

API-Keys

API-Keys ist die Seite, auf der Sie die Bearer-Tokens erzeugen, die Agenten, Integrationen und Custom Dashboards verwenden, um api.saiku.bi aufzurufen. Sie kommen einmal für jede Integration hierher, die Sie einrichten möchten, und danach regelmäßig für die Rotation.

Die Seite listet jeden Key in Ihrem Tenant mit einem Label, einer partiellen Key-ID, dem Ersteller, dem Erstellungsdatum und einem „Last used”-Zeitstempel auf, der nahezu in Echtzeit aktualisiert wird. Nützlich, um Keys zu erkennen, die nicht mehr verwendet werden (widerrufen) und Keys, die viel verwendet werden (die richtigen Kandidaten für eine Rotations-Überprüfung).

Einen Key erzeugen

  1. Klicken Sie auf Key erstellen und beschriften Sie ihn. Verwenden Sie einen Namen, der beschreibt, wofür er da ist: production-billing-agent, staging-bot, client-acme-integration. Labels erscheinen im Audit-Log, also machen Sie sie wiedererkennbar.

  2. Klicken Sie auf Erstellen.

  3. Kopieren Sie das Secret sofort. Es wird nur einmal angezeigt. Das Dashboard behält die Key-ID und das Label nach diesem Zeitpunkt, aber das tatsächliche Secret ist nicht mehr abrufbar — wir speichern es nicht in umkehrbarer Form.

  4. Fügen Sie es in den Secret Store Ihrer Integration ein. Testen Sie end-to-end.

Den Key verwenden

Senden Sie das Secret im Authorization-Header:

Terminal-Fenster
curl https://api.saiku.bi/me/tenant \
  -H "Authorization: Bearer sk_live_…"

Die vollständige Referenz lebt unter Authentifizierung — Basis-URL, Rate-Limits, Fehlerformat, alles.

Rotation

Eine saubere Rotation hat keine Ausfallzeit, weil beide Keys während der Umschaltung gültig sind.

  1. Erstellen Sie einen neuen Key mit demselben Label wie dem alten (hängen Sie -v2, -v3 an, damit Sie sie unterscheiden können).
  2. Stellen Sie den neuen Key in Ihrer Integration bereit.
  3. Bestätigen Sie, dass der neue Key verwendet wird — die Spalte Last used auf der Seite aktualisiert sich innerhalb einer Minute oder zwei.
  4. Widerrufen Sie den alten Key, sobald Sie sicher sind.

Widerrufen

Mülleimer-Symbol in der Zeile, bestätigen. Der Key wird sofort invalidiert — die nächste Anfrage, die ihn verwendet, erhält 401 Unauthorized. Es gibt keine Karenzfrist und kein Rückgängig, also widerrufen Sie überlegt.

Rate-Limits

Rate-Limits gelten pro Tenant, nicht pro Key, sodass die Verteilung der Last auf mehrere Keys Ihnen keinen zusätzlichen Spielraum gibt — es verteilt nur die Treffer auf Ihr Gesamtbudget. Siehe Authentifizierung für die Limits pro Plan.

Keys pro Agent

Best Practice für jedes nicht-triviale Deployment: ein Key pro Integration. Wenn ein Agent kompromittiert wird, widerrufen Sie seinen einen Key, ohne andere zu beeinflussen. Wenn Sie wissen möchten, welche Integration für eine bestimmte Anfrage verantwortlich ist, sagt es Ihnen die Spalte „Key-ID” im Audit-Log sofort.

Die Kosten dieser Praxis sind praktisch null — Keys sind günstig zu erzeugen, und das Dashboard wird nicht unhandlich, bis Sie bei Dutzenden sind.

Verwandt