API-Keys verwalten

Auf der Seite API Keys kannst du die Schlüssel erstellen, anzeigen und verwalten, mit denen deine Anwendungen die FourA API aufrufen.

Deine Schlüssel anzeigen

Die Seite zeigt jeden Schlüssel, auf den du Zugriff hast: deine persönlichen Schlüssel und jeden Schlüssel im Besitz einer Organisation, der du angehörst. Die Mitgliedschaft gewährt den Zugriff, daher sieht auch ein einfaches Mitglied die Schlüssel der Organisation.

Spalte	Angezeigter Inhalt
Name	Anzeigename und, falls festgelegt, die Beschreibung
Owner	`Personal` oder der Name der Organisation
Key Prefix	Maskiertes Präfix (`pk_live_••••••••`) mit Reveal-Schaltfläche oder ein Schloss-Symbol bei Legacy-Schlüsseln
Status	Active oder Inactive
Created	Wann der Schlüssel erstellt wurde
Last Used	Wann der Schlüssel zuletzt einen Request gesendet hat

Suche nach Name oder Beschreibung, filtere nach Active oder Inactive und sortiere nach einer beliebigen Spaltenüberschrift. Die Sortierreihenfolge wechselt zwischen absteigend, aufsteigend und aus.

Der Owner-Filter

Wenn du mindestens einer Organisation angehörst, erscheint neben dem Suchfeld ein Owner-Dropdown: Everything, Personal oder ein Eintrag pro Organisation. Es schränkt die Liste auf Schlüssel dieses Eigentümers ein. Dasselbe Steuerelement auf Overview, Metrics, Activity und Proxy folgt deiner Auswahl, sodass alle fünf Seiten immer übereinstimmen, wessen Traffic du betrachtest.

Einen Schlüssel erstellen

Klicke über der Liste auf Create Key (Create API key auf der leeren Seite vor deinem ersten Schlüssel) und fülle Folgendes aus:

Feld	Erforderlich	Beschreibung
Name	Ja	Ein beschreibendes Label, zum Beispiel "production-scraper" oder "staging-test"
Description	Nein	Notizen zum Verwendungszweck dieses Schlüssels
Owner	Ja, wenn du in einer Organisation bist	Personal oder eine Organisation, der du angehörst. Die Auswahl erscheint nur, wenn du mindestens einer angehörst.

Jedes Mitglied einer Organisation kann Schlüssel für diese erstellen, unabhängig von der Rolle. Das ist der Zweck der Einstellung: Die Nutzung eines Organisationsschlüssels wird dem Eigentümer der Organisation in Rechnung gestellt, sodass Entwickler keinen persönlichen Schlüssel benötigen, der stillschweigend ihnen statt dem Unternehmen berechnet wird.

Der vollständige Schlüssel wird direkt nach der Erstellung einmalig in einem kopierbereiten Dialog angezeigt. Du kannst ihn später mit Reveal erneut aufrufen. Schlüssel verwenden das Präfix pk_live_ und sehen aus wie pk_live_a1b2c3d4e5f6.... Du erhältst eine E-Mail zur Bestätigung der Schlüsselerstellung.

Einen Schlüssel aufdecken

Klicke auf das Augensymbol neben dem maskierten Präfix eines Schlüssels, um dessen vollständiges Secret erneut anzuzeigen. Das Dashboard bittet um Bestätigung und öffnet dann einen Dialog mit dem Klartext-Schlüssel, einer Kopierschaltfläche und einem kurzen Countdown. Nach Ablauf des Countdowns entfernt der Dialog das Secret von der Seite.

Jeder Aufruf wird im Audit-Log protokolliert, da dabei Zugangsdaten im Klartext offengelegt werden.

Jede Person, mit der der Schlüssel geteilt wird, kann ihn aufdecken: der persönliche Eigentümer oder jedes Mitglied der Organisation, die ihn besitzt.

Legacy-Schlüssel

Schlüssel, die vor der Einführung der Aufdeckfunktion erstellt wurden, zeigen ein Schloss-Symbol anstelle des Auges und können nicht aufgedeckt werden. Da nur ihr Hash gespeichert wurde, lässt sich das ursprüngliche Secret nicht wiederherstellen. Um einen Legacy-Schlüssel umzustellen, öffne das Aktionsmenü und wähle Regenerieren. Das neue Secret kann ab dann aufgedeckt werden.

Was jede Rolle tun darf

Bei einem persönlichen Schlüssel kannst du alles tun. Bei einem Organisationsschlüssel gelten drei Stufen:

Aktion	Mitglied	Admin	Inhaber
Schlüssel verwenden und aufdecken	Ja	Ja	Ja
Umbenennen, Beschreibung bearbeiten	Ja	Ja	Ja
Aktivieren oder deaktivieren	Nein	Ja	Ja
Secret regenerieren	Nein	Ja	Ja
Löschen	Nein	Ja	Ja
Aus der Organisation verschieben	Nein	Nein	Ja

Deaktivieren und Bearbeiten bleiben in der Zeile sichtbar, sind jedoch ausgegraut und mit einem Hinweis versehen, der den Grund erklärt. Regenerieren, Übertragen und Löschen erscheinen nicht im Menü, wenn deine Rolle sie nicht ausführen darf. Die API verweigert dieselben Aktionen, sodass eine Integration die Benutzeroberfläche nicht umgehen kann.

Die Aufteilung richtet sich danach, welche Auswirkungen die jeweilige Aktion auf andere Personen hat, die den Schlüssel nutzen. Das Umbenennen ist harmlos. Das Regenerieren oder Deaktivieren stoppt die Integration aller Kollegen in genau dem Moment, in dem es geschieht. Das Verschieben eines Schlüssels entzieht ihn dem Unternehmen und rechnet die Nutzung über den Plan des neuen Inhabers ab, daher ist dies allein dem Inhaber vorbehalten.

Einen Schlüssel bearbeiten

Klicke auf Bearbeiten, um den Namen und die Beschreibung zu aktualisieren. Die Inhaberschaft wird in diesem Dialog nicht geändert: Nutze dafür Übertragen.

Metriken anzeigen im Aktionsmenü öffnet die Übersicht, gefiltert nach diesem Schlüssel.

Aktivieren und Deaktivieren

Verwende Deaktivieren oder Aktivieren in der jeweiligen Zeile. Die Deaktivierung eines Schlüssels blockiert jeden API-Request, der ihn verwendet, und du kannst ihn jederzeit wieder aktivieren. Die Änderung wird innerhalb von Sekunden wirksam.

Einen Schlüssel regenerieren

Wenn du vermutest, dass ein Schlüssel kompromittiert wurde, öffne das Aktionsmenü und wähle Regenerieren. Dadurch wird ein neues Secret für dieselbe Schlüssel-ID erstellt. Das alte Secret funktioniert sofort nicht mehr. Name, Inhaber und alle anderen Einstellungen bleiben unverändert.

Das neue Secret bleibt auch nach dem Schließen des Dialogs aufdeckbar, sodass du es nicht zwingend beim ersten Versuch kopieren musst.

Einen Schlüssel übertragen

Übertragen im Aktionsmenü verschiebt einen Schlüssel zwischen persönlicher und organisatorischer Inhaberschaft, ohne das Secret neu zu generieren. Die Schlüssel-ID, die zugehörigen Metriken und der Aktivitätsverlauf bleiben erhalten. Es ändert sich nur der Inhaber und damit die Abrechnung der Nutzung.

Verschiebung	Wer es tun darf
Persönlicher Schlüssel in eine Organisation	Jeder, der dieser Organisation angehört
Organisationsschlüssel nach außen, zu dir selbst	Der Inhaber der Organisation
Zwischen zwei Organisationen	Der Inhaber der Organisation, die der Schlüssel verlässt

Ein Schlüssel, der in eine Organisation verschoben wird, tritt deren Standard-Team "Alle" bei, wodurch er für die Mitglieder sichtbar wird. Ein Schlüssel, der herausbewegt wird, verlässt jedes Team, in dem er sich befand.

Einen Schlüssel löschen

Öffne das Aktionsmenü und wähle Löschen. Wenn du einen bereits verwendeten Key löschst, wird er deaktiviert: Der Key authentifiziert nicht mehr und bleibt als Inaktiv in der Liste, damit der Name im Aktivitäts- und Metrik-Verlauf erhalten bleibt. Keys, die noch nie verwendet wurden, werden vollständig entfernt.

Du erhältst eine E-Mail, wenn ein Key gelöscht wird.

Organisations-Keys und Abrechnung

Die Nutzung eines Keys im Besitz einer Organisation wird auf den Plan des Organisationsinhabers angerechnet, unabhängig davon, wer den Request gesendet hat. Die Seite Nutzung & Limits des Inhabers zählt diese Keys neben den persönlichen Keys und trennt beide auf.