API-Keys verwalten
Auf der Seite „API-Keys“ kannst du die Keys erstellen, ansehen und verwalten, die deine Anwendungen für den Aufruf der FourA-API verwenden.
Deine Keys ansehen
Die Seite zeigt alle Keys, auf die du Zugriff hast:
- Persönliche Keys, die du direkt erstellt hast.
- Organisations-Keys, wenn du Besitzer oder Admin einer Organisation bist.
- Team-Keys, die durch eine Teammitgliedschaft mit dir geteilt wurden.
Jede Zeile in der Tabelle zeigt:
| Spalte | Inhalt |
|---|---|
| Name | Anzeigename und (optionale) Beschreibung |
| Key | Maskierter Präfix (z. B. pk_live_••••••••) mit einem „Reveal“-Button daneben |
| Besitzer | ME für persönliche Keys, TEAM für Organisations- oder Team-Keys |
| IP-Allowlist | Eingeschränkte IPs, falls festgelegt, oder „Alle IPs“, wenn unbeschränkt |
| Läuft ab | Ablaufdatum, falls festgelegt, oder „Nie“ |
| Status | Aktiv oder Inaktiv |
| Erstellt | Wann der Key erstellt wurde |
| Zuletzt verwendet | Wann der Key zuletzt einen Request gesendet hat |
Nutze das Suchfeld, um nach Name oder Beschreibung zu filtern, und den Statusfilter, um nur aktive oder inaktive Keys anzuzeigen.
Key erstellen
Klicke auf Create Key und fülle Folgendes aus:
| Feld | Erforderlich | Beschreibung |
|---|---|---|
| Name | Ja | Ein aussagekräftiges Label (z. B. "production-scraper" oder "staging-test") |
| Beschreibung | Nein | Hinweise zur Verwendung dieses Keys |
Wenn du einer Organisation angehörst, kannst du den Key auch dieser Organisation statt deinem persönlichen Konto zuweisen.
Der vollständige Key wird direkt nach der Erstellung einmalig in einem kopierbereiten Dialog angezeigt. Du kannst ihn später über Reveal (siehe unten) wieder anzeigen lassen, sofern der Key nach der Einführung des Reveal-Features erstellt wurde.
Keys verwenden das Präfix pk_live_ und sehen wie folgt aus: pk_live_a1b2c3d4e5f6.... Du erhältst eine E-Mail-Bestätigung, wenn ein neuer Key erstellt wird.
Key anzeigen (Reveal)
Klicke auf das Augensymbol neben dem maskierten Präfix eines Keys, um sein vollständiges Secret wieder anzuzeigen. Das Dashboard bittet dich um Bestätigung und öffnet dann einen Dialog mit dem unverschlüsselten Key, einem Kopier-Button und einem 15-Sekunden-Countdown. Nach Ablauf des Countdowns löscht der Dialog das Secret von der Seite.
Jeder Reveal-Vorgang wird im Audit-Log protokolliert, da er aktive Zugangsdaten offenlegt.
Legacy-Keys
Keys, die vor der Einführung dieses Features erstellt wurden, zeigen ein Schloss-Symbol anstelle des Auges und können nicht angezeigt werden. Da nur ihr Hash gespeichert wurde, ist das ursprüngliche Secret unwiederbringlich. Um einen Legacy-Key umzustellen, klicke auf das Aktionsmenü und wähle Regenerate. Das neue Secret kann ab diesem Zeitpunkt angezeigt werden.
Wer darf Keys anzeigen
| Rolle | Kann anzeigen |
|---|---|
| Key-Besitzer | Ja |
| Organisationsbesitzer / Admin (für Organisations-Keys) | Ja |
Teammitglied mit der Berechtigung write oder admin |
Ja |
Teammitglied mit der Berechtigung read |
Nein |
Key bearbeiten
Klicke in einer beliebigen Zeile auf Edit, um Folgendes zu aktualisieren:
- Anzeigename und Beschreibung
- IP-Allowlist (eine IP pro Zeile; leer lassen, um jede Quell-IP zuzulassen)
- Ablaufdatum (leer lassen für unbegrenzte Gültigkeit)
Andere Einstellungen (Organisationszuweisung, Besitzer) können nicht bearbeitet werden. Erstelle einen neuen Key, wenn du andere Besitzrechte benötigst.
Aktivieren und Deaktivieren
Nutze den Button Disable / Enable in der Zeile, um den Status eines Keys umzuschalten. Das Deaktivieren eines Keys blockiert alle API-Requests, die ihn verwenden. Du kannst ihn jederzeit wieder aktivieren. Die Änderung wird innerhalb von Sekunden wirksam.
Key regenerieren
Wenn du vermutest, dass ein Key kompromittiert wurde, öffne das Aktionsmenü (der Button mit den drei Punkten) und wähle Regenerate. Dadurch wird ein neues Secret für dieselbe Key-ID erstellt. Das alte Secret funktioniert sofort nicht mehr. Alle anderen Einstellungen (Name, Organisationszuweisung, IP-Allowlist, Ablaufdatum) bleiben unverändert.
Das neue Secret bleibt auch nach dem Schließen des Dialogs anzeigbar, sodass du es nicht sofort beim ersten Versuch perfekt kopieren musst.
Key löschen
Öffne das Aktionsmenü und wähle Delete. Standardmäßig deaktiviert das Löschen den Key (Soft Delete). Im Bestätigungsdialog kannst du ihn dauerhaft entfernen.
Du erhältst eine E-Mail-Benachrichtigung, wenn ein Key gelöscht wird.
Organisations-Keys
Unter einer Organisation erstellte Keys werden mit den Organisationsmitgliedern basierend auf ihrer Rolle geteilt:
- Besitzer und Admins sehen und bearbeiten alle Organisations-Keys.
- Mitglieder sehen nur Keys, die Teams zugewiesen sind, denen sie angehören.
Organisations-Keys werden bei der Erstellung automatisch dem Standard-Team der Organisation hinzugefügt.
Key-Berechtigungen über Teams
Teams steuern, wer auf welche Keys zugreifen kann. Jede Team-Key-Zuweisung hat eine Berechtigungsstufe:
| Berechtigung | Key ansehen | Anzeigen (Reveal) | Key-Einstellungen bearbeiten |
|---|---|---|---|
| read | Ja | Nein | Nein |
| write | Ja | Ja | Ja |
| admin | Ja | Ja | Ja |
Verwandte Themen
- Authentication: Wie API-Keys mit der API funktionieren
- Organizations and Teams: Gemeinsamen Zugriff einrichten
- Dashboard Overview: Alle Dashboard-Bereiche