Authentifizierung
Authentifizierung
Jeder Request an die FourA-API erfordert eine Authentifizierung. Diese Seite erklärt, wie du deinen API-Key erstellst, verwendest und verwaltest.
API-Key erstellen
- Melde dich im FourA-Dashboard an
- Gehe zur Seite API Keys
- Klicke auf Create Key
- Kopiere den Key aus dem Bestätigungsdialog
Dein API-Key sieht so aus: pk_live_a1b2c3d4e5f6...
Neu erstellte Keys lassen sich anzeigen: Klicke später auf das Augen-Symbol in der Zeile des Keys, um das vollständige Secret bei Bedarf wieder einzublenden (siehe API-Keys verwalten für den Anzeige-Ablauf und Berechtigungen). Ältere Keys, die vor dieser Funktion erstellt wurden, können nicht mehr angezeigt werden und zeigen ein Schloss-Symbol; generiere sie einmal neu, um zu wechseln.
API-Key verwenden
Füge deinen API-Key in den Header X-API-Key jedes Requests ein:
curl -X POST https://eu.api.foura.ai/api/single/ \
-H "X-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"method": "GET", "url": "https://example.com"}'
In Python:
import requests
response = requests.post(
"https://eu.api.foura.ai/api/single/",
headers={
"X-API-Key": "YOUR_API_KEY",
"Content-Type": "application/json"
},
json={"method": "GET", "url": "https://example.com"}
)
In Node.js:
const response = await fetch('https://eu.api.foura.ai/api/single/', {
method: 'POST',
headers: {
'X-API-Key': 'YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({ method: 'GET', url: 'https://example.com' })
});
API-Key-Sicherheit
Behandle deinen API-Key wie ein Passwort:
- Commiite ihn nicht in die Versionsverwaltung. Nutze stattdessen Umgebungsvariablen.
- Lege ihn nicht im clientseitigen Code offen. Verwende ihn nur in serverseitigen Anwendungen.
- Rotiere ihn bei Kompromittierung. Generiere den Key im Dashboard neu. Das alte Secret verliert innerhalb einer Minute seine Gültigkeit, und jede Anzeige wird im Audit-Log erfasst, sodass gestohlene Zugangsdaten im Nachhinein leicht zu erkennen sind.
Umgebungsvariablen verwenden
Speichere deinen Key in einer Umgebungsvariable:
export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."
Referenziere es dann in deinem Code:
import os
api_key = os.environ["FOURA_API_KEY"]
const apiKey = process.env.FOURA_API_KEY;
Häufige Authentifizierungsfehler
Alle Authentifizierungsfehler geben einen 401 Unauthorized-Status zurück.
| Fehler | Nachricht | Ursache | Lösung |
|---|---|---|---|
| 401 | Missing API key. Include X-API-Key header. | Kein X-API-Key-Header im Request |
Füge den X-API-Key-Header hinzu |
| 401 | Invalid API key | Falscher Key, zusätzliche Leerzeichen oder deaktivierter Key | Prüfe den Key, entferne Leerzeichen oder erstelle einen neuen Key im Dashboard |
Jede Response, ob Erfolg oder Fehler, enthält einen X-Foura-Request-Id-Header. Ausnahme: Ein Body, den FourA überhaupt nicht lesen kann (ungültiges JSON oder ein Body über 100 KB), wird abgelehnt, bevor eine ID zugewiesen wird. Protokolliere ihn auf deiner Seite, damit der Support einen bestimmten Aufruf später nachschlagen kann.
Nächste Schritte
- Schnellstart: Sende deinen ersten Request
- API-Keys verwalten: Keys anzeigen, bearbeiten, neu generieren und löschen
- API-Endpoints: Vollständige Endpoint-Referenz
- Fehlerbehandlung: Authentifizierungsfehler sauber behandeln