Überspringen zum Inhalt
DE
API-Schlüssel
Dokumentation durchsuchen

API-Referenz

Fehler und Statuscodes

Finden Sie die Ursache einer fehlgeschlagenen Anfrage und entscheiden Sie, ob Sie sie beheben, warten oder erneut versuchen möchten.

Auf dieser Seite

HTTP Statuscodes

Beginnen Sie mit dem HTTP-Status und lesen Sie dann den Fehlercode und die Nachricht für die spezifische Ursache.

StatusBedeutungLösung
400Antrag auf UngültigkeitBeheben Sie die Quelle, die erforderlichen Felder, die Parametertypen oder die Antwort-Header, bevor Sie erneut versuchen.
401Authentifizierung fehlgeschlagenÜberprüfen Sie X-API-Key. Ersetzen Sie einen abgelaufenen oder widerrufenen Schlüssel; Das erneute Versuchen des gleichen Schlüssels hilft nicht.
402Unzureichende KrediteÜberprüfen Sie den Kontostand. Fügen Sie Credits hinzu oder lassen Sie den Kontoinhaber den Zugriff aufheben, bevor Sie ihn erneut einreichen.
403Zugang verweigertÜberprüfen Sie die Quellberechtigungen des Schlüssels und den Konto- oder Abonnementstatus.
404Nicht gefundenÜberprüfen Sie die URL, Job ID und Konto. Jobs außerhalb Ihres zulässigen Kontos oder Ihrer Quellen können auch 404 zurückgeben.
406Antwortart nicht akzeptabelVerwenden Sie Accept: application/json oder text/plain. Wählen Sie Markdown mit X-Respond-With: Markdown.
409Ergebnis nicht bereit / KonfliktBei einem Ergebnis lesen, Pollen Sie den bestehenden Job, bis er abgeschlossen ist. Für andere Endpunkte lösen Sie den Konflikt, der im Körper beschrieben ist.
410Ergebnis abgelaufenVerwenden Sie eine gespeicherte Kopie. Das Wiederholen des Ergebnisses URL kann ein abgelaufenes Ergebnis nicht wiederherstellen.
422Ungültige Eingabe / fehlgeschlagener JobBeheben Sie die gemeldeten Felder. Überprüfen Sie bei einem Ergebnis job.error: Ein fehlgeschlagener Job hat kein erfolgreiches Ergebnis zu holen.
429Erreichen des GrenzwertesWarten Sie auf Retry-After oder retry_after. Reduzieren Sie die Anforderungsrate; Warten Sie für eine vollständige Warteschlange auf bestehende Jobs in finish.
500 / 502 / 503 / 504Service- oder Upstream-AusfallRetry liest sich mit begrenztem Backoff. Überprüfen Sie bei einem POST oder einem Einreichungs-Timeout, ob die Arbeit akzeptiert wurde, bevor Sie sie erneut senden.

Lesen Sie eine Fehlerantwort

API Fehler verwenden JSON, auch wenn Sie Klartext anfordern. Der Körper unterscheidet sich je nach Endpunkt. Verzweigen Sie den HTTP-Status und -Code, wenn vorhanden; Verwenden Sie die Nachricht oder das Detail, um das Problem zu erklären.

Abfragefehler umfassen häufig Fehler und Nachricht; Code ist optional. Authentifizierungsfehler können success: false anstelle von error: true verwenden.

400 · application/json
{
  "error": true,
  "code": "unsupported_representation",
  "message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}

Status, Kopfzeilen und Körper überprüfen

Verwenden Sie curl --include, um alle drei zu sehen. Dieses Beispiel überprüft Ihren Schlüssel mit einem kostenlosen Konto gelesen; es sendet keine Abfrage. Stellen Sie FLASHDATA_API_KEY zuerst in Ihrer Umgebung ein.

Überprüfen Sie eine Antwort · cURL / Bash
curl --include --silent --show-error --max-time 20 \
  'https://api.flashdata.dev/v2/api-access/identity' \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json'

Wann man es erneut versucht

Eine wiederholte POST kann eine weitere abrechenbare Abfrage erstellen. Ein Netzwerk-Timeout beweist nicht, dass die erste Anfrage abgelehnt wurde. Speichern Sie den Job ID, sobald Sie ihn erhalten haben.

LageNächste Maßnahme
Ungültige Eingabe, Schlüssel, Berechtigung oder KontostandStoppen. Beheben Sie den Status der Anforderung oder des Kontos, bevor Sie erneut versuchen; Loopen Sie diese Fehler nicht.
429 mit einem WartehinweisRetry-After (Sekunden- oder HTTP-Datum) oder den JSON retry_after-Wert in Sekunden. Wenn beide vorhanden sind, verwenden Sie die längere Verzögerung.
Read Request: 429 / temporärer 5xx / NetzwerkfehlerVersuchen Sie dasselbe GET. Verwenden Sie ohne Wartehinweis zunehmende Verzögerungen mit Jitter, eine maximale Versuchszahl und ein Zeitlimit.
POST Timeout oder mehrdeutig 5xxBehalten Sie den vorhandenen Job ID und überprüfen Sie dessen Status. Wenn kein ID empfangen wurde, überprüfen Sie die Jobhistorie, bevor Sie sich entscheiden, erneut einzureichen.

Überprüfen Sie einen Hintergrundjob

HTTP 200 vom Statusendpunkt bedeutet, dass das Lesen erfolgreich war. Überprüfen Sie job.status, um zu wissen, ob die Aufgabe erfolgreich war. Setzen Sie JOB_ID auf Ihren bestehenden Job; dieser Befehl sendet keinen Ersatz.

job.statusLösung
pending / processingWarten Sie, dann wählen Sie den gleichen Job. Ein Ergebnislesen gibt 409 bis zum Abschluss zurück.
completedRetrieve und speichern Sie das Ergebnis. Originale JSON-Ergebnisse geben eine 302-Speicherumleitung zurück; formatierte Ergebnisse geben einen Körper direkt zurück.
failedStoppen Sie die Umfrage und inspizieren Sie job.error. Der Endpunkt des Ergebnisses gibt 422 mit dem Code result_not_ready für einen fehlgeschlagenen Job zurück.
Jobstatus lesen · cURL / Bash
curl --fail-with-body --silent --show-error --max-time 30 \
  "https://api.flashdata.dev/v2/jobs/${JOB_ID:?Set JOB_ID}" \
  --header "X-API-Key: ${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY}" \
  --header 'Accept: application/json'

Fehler im Antwortformat

Status/CodeFixpunkt
400 · unsupported_representationStellen Sie X-Respond-With auf Markdown oder entfernen Sie den Header.
406 · not_acceptableSetzen Sie Accept auf application/json oder text/plain; verwenden Sie UTF-8, wenn Sie ein Zeichen angeben.

Holen Sie sich Hilfe bei einer Anfrage

Senden Sie den Endpunkt, den UTC-Zeitstempel, den HTTP-Status, den Fehlercode und die Anforderung oder den Job ID. Entfernen Sie API-Schlüssel, Token und signiertes URLs aus dem Bericht.