Zum Inhalt

So generieren und verwalten Sie API-Schlüssel sicher

🤖 Erklären mit KI

API-Schlüssel sind die digitalen Anmeldeinformationen, mit denen Ihre benutzerdefinierte Software oder Anwendungen von Drittanbietern sicher mit dem 4Geeks-Ökosystem kommunizieren können. Unabhängig davon, ob Sie Auszahlungen über 4Geeks Payments automatisieren, Kandidatendaten von 4Geeks Talent synchronisieren oder Krankenakten mit 4Geeks Health integrieren, ein sicherer API-Schlüssel ist Ihr Ausgangspunkt.

Dieser Leitfaden bietet eine umfassende Anleitung zum Generieren, Verwalten und Sichern Ihrer API-Schlüssel mithilfe der 4Geeks Console. Indem Sie diese Schritte befolgen, stellen Sie sicher, dass Ihre Integrationen robust bleiben, während die Daten Ihrer Organisation sicher bleiben.

Voraussetzungen

Bevor Sie mit der Generierung von Schlüsseln beginnen, stellen Sie sicher, dass Sie die folgenden Anforderungen erfüllen:

  • Kontozugriff: Sie müssen über ein aktives Konto auf der 4Geeks Console verfügen.
  • Benutzerberechtigungen: Sie benötigen „Admin“- oder „Developer“-Zugriffsrechte. Allgemeine Benutzer haben normalerweise keine Berechtigung zum Anzeigen oder Erstellen von API-Schlüsseln.
  • Sicherheitseinrichtung: Es wird dringend empfohlen, dass Sie die Zwei-Faktor-Authentifizierung (2FA) in Ihrem Konto aktiviert haben, bevor Sie Aktionen mit hoher Sicherheit wie die Schlüsselgenerierung durchführen.

Schritt-für-Schritt-Anleitung

Befolgen Sie diese Schritte, um einen neuen API-Schlüssel zu erstellen.

Schritt 1: Zugriff auf die Entwicklereinstellungen

  1. Melden Sie sich bei Ihrer 4Geeks Console an.
  2. Suchen Sie in der Hauptnavigationsleiste und klicken Sie auf Settings.
  3. Wählen Sie aus dem Dropdown- oder Einstellungsmenü API & Developers.

Schritt 2: Generieren Sie einen neuen Schlüssel

  1. Im Abschnitt API Keys sehen Sie eine Liste vorhandener Schlüssel (falls vorhanden). Klicken Sie auf die Schaltfläche + Generate New Key.
  2. Benennen Sie Ihren Schlüssel: Geben Sie im Feld „Label“ einen beschreibenden Namen ein.
    • Tipp: Verwenden Sie eine Namenskonvention, die den Zweck des Schlüssels und den Dienst identifiziert, der ihn verwendet (z. B. Zapier-Integration-Payroll oder Internal-App-Health).
  3. Ablauf festlegen (Optional): Für erhöhte Sicherheit können Sie ein Ablaufdatum festlegen. Wenn dieser Schlüssel für ein temporäres Projekt bestimmt ist, wählen Sie ein Datum aus; andernfalls lassen Sie es als „Never Expire“ stehen.

Schritt 3: Berechtigungen definieren (Scopes)

Um dem Prinzip der geringsten Rechte zu entsprechen, gewähren Sie nur die für die spezifische Aufgabe erforderlichen Berechtigungen.

  1. Überprüfen Sie die Liste der verfügbaren Produkte (z. B. 4Geeks Asset, 4Geeks Perks).
  2. Schalten Sie die spezifischen Read- oder Write-Berechtigungen ein, die erforderlich sind.
    • Beispiel: Wenn der Schlüssel für einen Dashboard-Viewer bestimmt ist, gewähren Sie Read-Only-Zugriff auf 4Geeks Asset. Gewähren Sie keinen Write-Zugriff auf 4Geeks Payroll, es sei denn, die Integration erfordert ausdrücklich die Änderung von Gehaltsdaten.
  3. Klicken Sie auf Create Key.

Schritt 4: Kopieren und Speichern Ihres Schlüssels

Wichtiger Schritt: Sobald der Schlüssel generiert wurde, zeigt ein Modal den vollständigen API Secret Key an.

  1. Klicken Sie auf das Copy-Symbol, um die Zeichenfolge in Ihre Zwischenablage zu kopieren.
  2. Fügen Sie diesen Schlüssel sofort in Ihren sicheren Tresor, Passwortmanager oder Ihre Umgebungsvariablendatei (.env) ein.
  3. Hinweis: Aus Sicherheitsgründen wird 4Geeks diesen vollständigen Schlüssel nie wieder anzeigen. Wenn Sie ihn verlieren, müssen Sie einen neuen generieren und Ihre Integrationen aktualisieren.

Häufige Anwendungsfälle

Das Verständnis, wie diese Schlüssel angewendet werden, kann dazu beitragen, Ihre Abläufe in der gesamten 4Geeks-Suite zu rationalisieren.

Szenario 1: Automatisierung von Onboarding-Workflows

Situation: Ihr HR-Team verwendet ein benutzerdefiniertes internes Portal und möchte Onboarding-Aufgaben automatisch auslösen, wenn eine neue Einstellung genehmigt wird. Anwendung: Sie generieren einen API-Schlüssel mit „Write“-Zugriff auf 4Geeks Talent. Wenn ein Kandidat in Ihrem internen System als „Eingestellt“ markiert ist, authentifiziert der API-Schlüssel eine Anfrage an 4Geeks Talent, um die Onboarding-Sequenz zu initiieren.

Szenario 2: Inventar synchronisieren für E-Commerce

Situation: Sie nutzen 4Geeks Asset für die Bestandsverfolgung, verwenden jedoch ein Drittanbieter-Tool für den Front-End-Verkauf. Anwendung: Durch Erstellen eines „Read-Only“-API-Schlüssels für Ihre Verkaufsplattform kann diese alle 15 Minuten 4Geeks Asset abfragen, um Echtzeit-Lagerbestände abzurufen und sicherzustellen, dass Sie niemals ein Produkt überverkaufen.

Fehlerbehebung

Wenn Ihre Integrationen fehlschlagen, überprüfen Sie diese häufigen Probleme im Zusammenhang mit API-Schlüsseln.

Problem 1: HTTP 401 Unauthorized Fehler

  • Ursache: Der API-Schlüssel fehlt, ist falsch oder wurde gelöscht.
  • Lösung: Überprüfen Sie Ihren Anwendungscode, um sicherzustellen, dass der Schlüssel im Header korrekt übergeben wird (normalerweise Authorization: Bearer YOUR_API_KEY). Wenn der Code korrekt ist, überprüfen Sie in der 4Geeks Console, ob der Schlüsselstatus „Active“ ist.

Problem 2: HTTP 403 Forbidden Fehler

  • Ursache: Der Schlüssel funktioniert, hat aber keine Berechtigung, auf die spezifische Ressource zuzugreifen.
  • Lösung: Sie haben wahrscheinlich den Scope während Schritt 3 eingeschränkt. Wenn Sie beispielsweise versuchen, Endpunkte von 4Geeks AI Agents zu verwenden, aber nur Berechtigungen für 4Geeks Perks aktiviert haben, schlägt die Anfrage fehl. Generieren Sie einen neuen Schlüssel mit den korrekten Scopes.

Problem 3: Schlüsselkompromittierung

  • Ursache: Ein Entwickler hat den API-Schlüssel versehentlich in ein öffentliches GitHub-Repository übertragen.
  • Lösung: Behandeln Sie dies als Sicherheitsnotfall. Melden Sie sich sofort bei der Konsole an, suchen Sie den kompromittierten Schlüssel und klicken Sie auf Revoke/Delete. Generieren Sie einen neuen Schlüssel und aktualisieren Sie Ihre Umgebungsvariablen.

Best Practices für Sicherheit

  • Schlüssel rotieren: Ändern Sie Ihre API-Schlüssel regelmäßig (z. B. alle 90 Tage), um das Risiko kompromittierter Anmeldeinformationen zu verringern.
  • Umgebungsvariablen verwenden: Codieren Sie API-Schlüssel niemals direkt fest in Ihren Anwendungsquellcode.
  • Scopes einschränken: Generieren Sie niemals einen „Super-Admin“-Schlüssel mit Zugriff auf alles, es sei denn, dies ist absolut notwendig. Wenn ein Schlüssel nur für 4Geeks Payroll benötigt wird, geben Sie ihm keinen Zugriff auf 4Geeks Health-Daten.

Fazit

Die sichere Verwaltung von API-Schlüsseln ist das Fundament einer stabilen und sicheren technischen Infrastruktur. Durch die korrekte Konfiguration von Berechtigungen und den sorgfältigen Umgang mit Ihren Anmeldeinformationen können Sie das volle Potenzial der Automatisierung im 4Geeks-Ökosystem ausschöpfen.

Bereit, Ihre erste Integration zu erstellen? Besuchen Sie die 4Geeks Console, um loszulegen.

Zusätzliche Ressourcen