Zum Hauptinhalt springen

Klar Public API

Verfasst von Valentine Strunz-Happe

Klars Public API ermöglicht den programmatischen Zugriff auf deine Attributions-, Marketing- und Umsatzmetriken. Dieser Guide richtet sich an Account Owner und Admins, die steuern möchten, wie ihr Team sicher auf diese Daten zugreift.

Für Entwickler, die Integrationen bauen: Die vollständigen Endpunkt-Spezifikationen findest du in der technischen Dokumentation:

Schritt 1: Team-Berechtigungen einrichten

Bevor jemand Keys verwalten kann, braucht er die richtigen Zugriffsrechte.

  1. Gehe zu deinem Bereich ‚Kontoeinstellungen' > ‚Nutzer' > ‚Zugriff verwalten'.

  2. Erstelle oder bearbeite eine Rolle so, dass sie die Berechtigung ‚Einstellungen' > ‚API-Key-Verwaltung' enthält.

  3. Weise diese Rolle den Teammitgliedern zu (z. B. Data Engineers, Analysten), die API-Keys verwalten (erstellen oder widerrufen) müssen.

Hinweis: Nur Nutzer mit der Rolle Account Owner oder der Berechtigung ‚API-Key-Verwaltung' können das API-Keys-Dashboard sehen.

Schritt 2: API-Keys erstellen & verwalten

  1. Gehe zu Kontoeinstellungen > API Keys.

  2. Klicke auf ‚Neuen Secret Key erstellen'.

  3. Benennung: Gib deinem Key einen klaren, aussagekräftigen Namen (z. B. ‚Tableau Integration').

  4. Scoping: Lege fest, welche Berechtigungen dieser Key haben soll (Attribution, Marketing, Revenue & Profit). Tipp: Halte dich an das Least-Privilege-Prinzip – wähle nur die Scopes aus, die die jeweilige Integration wirklich braucht.

  5. Wichtiger Sicherheitshinweis: Sobald du auf ‚Erstellen' klickst, wird der rohe API-Key nur einmal angezeigt. Kopiere und speichere ihn sofort in deinem sicheren Passwort-Manager oder Umgebungsvariablen-System. Er kann nicht wiederhergestellt werden, wenn er verloren geht.

Schritt 3: Key-Lebenszyklus & Sicherheit

  • Widerrufen: Wird eine Integration nicht mehr gebraucht, widerrufe den Key sofort, um diesen Zugangspunkt zu schließen.

  • Mitarbeiter-Offboarding: API-Keys sind an ihren Ersteller gebunden. Wird ein Nutzerkonto gelöscht oder gesperrt, werden alle zugehörigen Keys automatisch widerrufen (nach einer Bestätigungsabfrage)

Troubleshooting & FAQ

  • Warum sehe ich den API-Keys-Tab nicht? Stelle sicher, dass du Account Owner bist oder eine Rolle mit aktivierter Berechtigung ‚API-Key-Verwaltung' hast.

Technische Dokumentation

Für Entwickler, die Integrationen bauen: Die vollständigen Endpunkt-Spezifikationen findest du in der technischen API-Dokumentation.

Hat dies deine Frage beantwortet?