Authentifizierung
Jeder Request an die FourA-API erfordert eine Authentifizierung. Diese Seite erklärt, wie du deinen API-Key erhältst, verwendest und verwaltest.
API-Key erhalten
- 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 in der Zeile des Keys auf das Augensymbol, um das vollständige Secret bei Bedarf erneut einzusehen (Details zum Ablauf und den Berechtigungen findest du unter API-Keys verwalten). Ältere Keys, die vor dieser Funktion erstellt wurden, können nicht mehr angezeigt werden und zeigen ein Schlosssymbol; generiere sie einmal neu, um umzusteigen.
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' })
});
Sicherheit von API-Keys
Behandle deinen API-Key wie ein Passwort:
- Committe ihn nicht in die Versionskontrolle. Nutze stattdessen Umgebungsvariablen.
- Gib ihn nicht in clientseitigem Code preis. Verwende ihn ausschliesslich in serverseitigen Anwendungen.
- Rotiere ihn bei Kompromittierung. Generiere den Key im Dashboard neu. Der alte Secret verliert innerhalb einer Minute seine Gueltigkeit, und jeder Aufruf wird auditiert, sodass ein gestohlenes Secret im Nachhinein leicht erkennbar ist.
Umgebungsvariablen verwenden
Speichere deinen Key in einer Umgebungsvariablen:
export FOURA_API_KEY="pk_live_a1b2c3d4e5f6..."
Referenziere ihn 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 den Status 401 Unauthorized zurück.
| Error | Message | Cause | Fix |
|---|---|---|---|
| 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, überflüssige Leerzeichen oder deaktivierter Key | Überprüfe den Key, entferne Leerzeichen oder erstelle einen neuen Key im Dashboard |
Falls FourA einen Key vorübergehend nicht prüfen kann, etwa während eines Datenbank-Failovers, antwortet der Dienst mit 503 samt API key check temporarily unavailable und Retry-After: 5, niemals mit 401. Wiederhole den Request nach dieser Wartezeit: Dein Key ist gültig.
Jede Response, ob Erfolg oder Fehler, enthält einen X-Foura-Request-Id-Header. Eine Ausnahme bilden Bodys, die FourA überhaupt nicht lesen kann (ungültiges JSON oder mehr als 100 KB), da diese abgelehnt werden, bevor eine ID zugewiesen wird. Protokolliere diesen Header auf deiner Seite, damit der Support spätere Aufrufe nachvollziehen 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 abfangen