Fehlerbehandlung

Fehlerformat

API-Fehler folgen dem Problem-Details-Format nach RFC 7807. Der Inhaltstyp einer Fehlerantwort ist application/problem+json. Die Problem-Felder stehen in einem error-Objekt:

json

{
    "success": false,
    "error": {
        "type": "https://idparse.com/errors/invalid-api-key",
        "code": "invalid_api_key",
        "title": "Invalid API Key",
        "status": 401,
        "detail": "The API key provided is missing or invalid."
    }
}

Feld	Beschreibung
`success`	In einer Fehlerantwort immer `false`
`error.type`	Eine URI, die den Fehlertyp identifiziert. Der letzte Teil verwendet Bindestriche, zum Beispiel `invalid-api-key`
`error.code`	Derselbe Name in Kleinbuchstaben mit Unterstrichen, zum Beispiel `invalid_api_key`. Verwenden Sie dieses Feld in Ihrem Code
`error.title`	Eine kurze, menschenlesbare Zusammenfassung
`error.status`	Der HTTP-Statuscode
`error.detail`	Eine längere Erklärung. Der Text kann sich ändern, vergleichen Sie ihn also nicht in Ihrem Code

Fehlercodes

Fehlercode	HTTP-Status	Beschreibung
`invalid_api_key`	401	Der API-Schlüssel fehlt oder ist falsch
`conflicting_credentials`	401	Der `Authorization`-Header und der `X-API-Key`-Header enthalten verschiedene Schlüssel. Senden Sie nur einen von beiden
`inactive_account`	403	Der API-Schlüssel ist deaktiviert, das Konto ist gesperrt oder die E-Mail-Adresse ist nicht bestätigt
`file_too_large`	413	Die hochgeladene Datei ist größer als 25 MB
`invalid_file`	422	Die Anfrage enthält nicht genau eine nicht leere Datei im Multipart-Feld `file`
`rate_limited`	429	Das Limit pro Minute wurde überschritten, oder der Begrenzer ist vorübergehend nicht verfügbar und Anfragen werden für kurze Zeit abgelehnt. Enthält einen `Retry-After`-Header
`quota_exhausted`	429	Alle enthaltenen Scans dieses Monats sind verbraucht. Enthält einen `Retry-After`-Header
`bad_engine_result`	502	Der Verarbeitungsdienst hat eine Antwort gegeben, die nicht validiert werden konnte. Nicht berechnet
`engine_busy`	503	Alle Verarbeitungsplätze sind belegt. Enthält einen `Retry-After`-Header. Nicht berechnet
`engine_unavailable`	503	Der Verarbeitungsdienst ist im Moment nicht erreichbar. Enthält einen `Retry-After`-Header. Nicht berechnet
`service_unavailable`	503	Die API wird gewartet, oder die Nutzungslimits können im Moment nicht geprüft werden. Enthält einen `Retry-After`-Header. Nicht berechnet
`engine_timeout`	504	Das Dokument konnte nicht rechtzeitig verarbeitet werden. Nicht berechnet

Eine Fehlerantwort wird nie berechnet. Das gilt für jeden 4xx-Status und jeden 5xx-Status.

Hinweis

Wenn Sie einen 429-Fehler oder einen 503-Fehler erhalten, prüfen Sie den Retry-After-Header. Er nennt die Zahl der Sekunden, die Sie vor einem neuen Versuch warten sollten. Siehe Limits und Kontingent und Wann Sie wiederholen sollten.

Fehler und nicht lesbare Dokumente

Ein Dokument, das nicht gelesen werden konnte, ist kein Fehler. Die API antwortet mit HTTP 200, "success": false und einem failure_reason. In dieser Antwort gibt es kein error-Objekt. Siehe Fehlergründe.

Situation	HTTP-Status	Inhalt
Das Dokument wurde gelesen und validiert	200	`"success": true` und die extrahierten `fields`
Das Dokument konnte nicht gelesen werden	200	`"success": false` und ein `failure_reason`
Die Anfrage wurde abgelehnt oder der Dienst ist ausgefallen	4xx oder 5xx	`"success": false` und ein `error`-Objekt

Hilfe erhalten

Wenn Sie sich an den Support wenden, nennen Sie Ihr Konto, die Zeit der Anfrage und den Endpunkt. Senden Sie niemals Dokumentbilder oder extrahierte Daten. Jede Antwort trägt einen X-Request-ID-Header. Er hilft Ihnen, eine Anfrage in Ihren eigenen Protokollen wiederzufinden.