Dokumentation durchsuchen
API-Referenz
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.
| Status | Bedeutung | Lösung |
|---|---|---|
| 400 | Antrag auf Ungültigkeit | Beheben Sie die Quelle, die erforderlichen Felder, die Parametertypen oder die Antwort-Header, bevor Sie erneut versuchen. |
| 401 | Authentifizierung fehlgeschlagen | Überprüfen Sie X-API-Key. Ersetzen Sie einen abgelaufenen oder widerrufenen Schlüssel; Das erneute Versuchen des gleichen Schlüssels hilft nicht. |
| 402 | Unzureichende Kredite | Überprüfen Sie den Kontostand. Fügen Sie Credits hinzu oder lassen Sie den Kontoinhaber den Zugriff aufheben, bevor Sie ihn erneut einreichen. |
| 403 | Zugang verweigert | Überprüfen Sie die Quellberechtigungen des Schlüssels und den Konto- oder Abonnementstatus. |
| 404 | Nicht 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. |
| 406 | Antwortart nicht akzeptabel | Verwenden Sie Accept: application/json oder text/plain. Wählen Sie Markdown mit X-Respond-With: Markdown. |
| 409 | Ergebnis nicht bereit / Konflikt | Bei 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. |
| 410 | Ergebnis abgelaufen | Verwenden Sie eine gespeicherte Kopie. Das Wiederholen des Ergebnisses URL kann ein abgelaufenes Ergebnis nicht wiederherstellen. |
| 422 | Ungültige Eingabe / fehlgeschlagener Job | Beheben Sie die gemeldeten Felder. Überprüfen Sie bei einem Ergebnis job.error: Ein fehlgeschlagener Job hat kein erfolgreiches Ergebnis zu holen. |
| 429 | Erreichen des Grenzwertes | Warten 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 / 504 | Service- oder Upstream-Ausfall | Retry 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.
{
"error": true,
"code": "unsupported_representation",
"message": "X-Respond-With supports markdown. Omit the header for the original result fields."
}V2-Problemantworten verwenden application/problem+json. Halten Sie requestId für die Unterstützung. Validierungsfehler können auch fieldErrors mit Feld, Code und Nachricht enthalten.
{
"type": "https://api.flashdata.dev/problems/invalid_api_key",
"title": "Invalid API Key",
"status": 401,
"code": "invalid_api_key",
"requestId": "example-request-id",
"detail": "The API Key is invalid or unavailable."
}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.
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.
| Lage | Nächste Maßnahme |
|---|---|
| Ungültige Eingabe, Schlüssel, Berechtigung oder Kontostand | Stoppen. Beheben Sie den Status der Anforderung oder des Kontos, bevor Sie erneut versuchen; Loopen Sie diese Fehler nicht. |
| 429 mit einem Wartehinweis | Retry-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 / Netzwerkfehler | Versuchen Sie dasselbe GET. Verwenden Sie ohne Wartehinweis zunehmende Verzögerungen mit Jitter, eine maximale Versuchszahl und ein Zeitlimit. |
| POST Timeout oder mehrdeutig 5xx | Behalten 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.status | Lösung |
|---|---|
| pending / processing | Warten Sie, dann wählen Sie den gleichen Job. Ein Ergebnislesen gibt 409 bis zum Abschluss zurück. |
| completed | Retrieve und speichern Sie das Ergebnis. Originale JSON-Ergebnisse geben eine 302-Speicherumleitung zurück; formatierte Ergebnisse geben einen Körper direkt zurück. |
| failed | Stoppen 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. |
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/Code | Fixpunkt |
|---|---|
| 400 · unsupported_representation | Stellen Sie X-Respond-With auf Markdown oder entfernen Sie den Header. |
| 406 · not_acceptable | Setzen 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.