API-Keys verwalten
Auf der Seite API Keys kannst du die Schlüssel erstellen, anzeigen und verwalten, die deine Anwendungen verwenden, um die FourA API aufzurufen.
Deine Schlüssel anzeigen
Die Seite zeigt jeden Schlüssel, auf den du Zugriff hast:
- Persönliche Schlüssel, die du direkt erstellt hast.
- Organisationsschlüssel, wenn du Inhaber oder Administrator einer Organisation bist, oder wenn ein Schlüssel, der dir gehört, an eine deiner Organisationen übertragen wurde.
Jede Zeile in der Tabelle zeigt:
| Spalte | Was sie anzeigt |
|---|---|
| Name | Anzeigename und (optional) Beschreibung |
| Key | Maskiertes Präfix (z.B. pk_live_••••••••) mit einem Anzeigen-Button daneben |
| Owner | Personal für persönliche Schlüssel, oder der Name der Organisation für Schlüssel im Besitz der Organisation |
| Status | Active oder Inactive |
| Created | Wann der Schlüssel erstellt wurde |
| Last Used | Wann der Schlüssel zuletzt einen Request gemacht hat |
Nutze das Suchfeld, um nach Name oder Beschreibung zu filtern, und den Statusfilter, um nur aktive oder inaktive Schlüssel anzuzeigen. Jeder Spaltenkopf ist sortierbar.
Einen Schlüssel 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") |
| Description | Nein | Notizen wofür dieser Schlüssel verwendet wird |
| Owner | Ja, wenn du in einer Org bist | Personal, oder eine der Organisationen, denen du angehörst. Die Auswahl erscheint nur, wenn du mindestens eine Org hast. |
Der vollständige Schlüssel wird einmal direkt nach der Erstellung in einem kopierbereiten Dialog angezeigt. Du kannst ihn auch später über Reveal wieder aufrufen (siehe unten).
Schlüssel verwenden das Präfix pk_live_ und sehen aus wie pk_live_a1b2c3d4e5f6.... Du erhältst eine E-Mail-Bestätigung, wenn ein neuer Schlüssel erstellt wird.
Einen Schlüssel anzeigen
Klicke auf das Augen-Symbol neben dem maskierten Präfix eines Schlüssels, um sein vollständiges Geheimnis wieder zu sehen. Das Dashboard bittet dich zu bestätigen, und öffnet dann einen Dialog mit dem unverschlüsselten Schlüssel, einem Kopieren-Button und einem kurzen Countdown. Nach dem Countdown löscht der Dialog das Geheimnis von der Seite.
Jede Anzeige wird im Audit-Log aufgezeichnet, da sie ein Live-Credential freilegt.
Legacy-Schlüssel
Schlüssel, die erstellt wurden, bevor das Feature zur Anzeige veröffentlicht wurde, zeigen ein Schloss-Symbol anstelle des Auges und können nicht angezeigt werden. Es wurde nur ihr Hash gespeichert, daher ist das ursprüngliche Geheimnis unwiederbringlich. Um einen Legacy-Schlüssel umzustellen, klicke auf das Aktionsmenü und wähle Regenerate. Das neue Geheimnis kann ab dann angezeigt werden.
Wer kann anzeigen
| Rolle | Kann anzeigen |
|---|---|
| Schlüssel-Inhaber | Ja |
| Org-Inhaber oder Admin (für Schlüssel im Org-Besitz) | Ja |
| Jeder andere | Nein |
Einen Schlüssel bearbeiten
Klicke auf Edit in einer beliebigen Zeile, um den Anzeigenamen und die Beschreibung zu aktualisieren. Der Besitz (Personal vs Org) wird hier nicht geändert. Nutze Transfer unten, um einen Schlüssel zwischen Besitzern zu verschieben.
Aktivieren und Deaktivieren
Nutze den Button Disable / Enable in der Zeile, um den Status eines Schlüssels umzuschalten. Das Deaktivieren eines Schlüssels blockiert alle API-Requests, die ihn verwenden. Du kannst ihn jederzeit reaktivieren. Die Änderung wird innerhalb von Sekunden wirksam.
Einen Schlüssel neu generieren
Wenn du vermutest, dass ein Key kompromittiert wurde, öffne das Aktionsmenü (der Button mit den drei Punkten) und wähle Regenerate aus. Dies erstellt ein neues Secret für dieselbe Key ID. Das alte Secret funktioniert sofort nicht mehr. Name, Org-Zuweisung und andere Einstellungen bleiben gleich.
Das neue Secret bleibt nach dem Schließen des Dialogs einsehbar, sodass du es nicht beim ersten Versuch perfekt kopieren musst.
Key übertragen
Jede Zeile hat eine Transfer-Aktion im Menü. Nutze sie, um einen Key zwischen persönlichem und Org-Besitz zu verschieben, ohne das Secret neu zu generieren. Die Key ID, ihre Metriken und der Aktivitätsverlauf bleiben erhalten; nur der Eigentümer ändert sich.
Häufige Fälle:
- Verschiebe einen persönlichen Key, den du für ein geteiltes Projekt erstellt hast, in die Org, damit ein Teamkollege ihn nach dir verwalten kann.
- Weise dir einen Org Key wieder selbst zu, wenn das Projekt ausgegliedert wird.
Du kannst einen Key in deinem Besitz (persönlich) in jede Org übertragen, in der du Owner oder Admin bist, und du kannst einen von dir verwalteten Org Key an dich selbst oder zwischen von dir verwalteten Orgs übertragen.
Key löschen
Öffne das Aktionsmenü und wähle Delete aus. Das Löschen eines zuvor genutzten Keys führt zu einem Soft-Delete: Der Key verliert die Authentifizierung, aber sein Aktivitäts- und Metriken-Verlauf bleibt intakt. Keys, die noch nie genutzt wurden, können endgültig gelöscht (hard-deleted) werden.
Du erhältst eine E-Mail-Benachrichtigung, wenn ein Key gelöscht wird.
Organization Keys
Keys im Besitz einer Organisation sind für Org-Owner und -Admins sichtbar. Mitglieder ohne Owner- oder Admin-Rolle sehen diese nicht.
Die Nutzung eines Org-eigenen Keys wird auf den Tarif des Org-Owners angerechnet.
Verwandte Themen
- Authentication: Wie API Keys mit der API funktionieren
- Organizations and Teams: Geteilten Zugriff einrichten
- Dashboard Overview: Alle Dashboard-Bereiche