API

API-Fehler

Wie Everyn-API-Fehler klassifiziert werden und welche Recovery-Aktion folgt.

Everyn-API-Fehler nutzen ein öffentliches Envelope, damit Clients Fehler konsistent klassifizieren können. code sagt, was fehlgeschlagen ist, requestId hilft Operatoren bei der Suche, und docsUrl verweist auf die spezifischste verfügbare Recovery-Anleitung.

Error Envelope

Öffentliches Envelope:

{
  "error": {
    "status": 422,
    "code": "validation_failed",
    "message": "Request validation failed.",
    "requestId": "req_...",
    "docsUrl": "https://www.geteveryn.com/de/docs/errors/validation_failed",
    "fieldErrors": [
      {
        "source": { "pointer": "/outputSchema/columns/0/name" },
        "code": "invalid_column_name",
        "message": "Column names must match ^[a-z][a-z0-9_]*$."
      }
    ]
  }
}

Recovery-Matrix:

Status und CodeTypische UrsacheClient-Verhalten
400 validation_failedFehlerhaftes JSON, Multipart Metadata, ungültiger Cursor oder fehlender Protokoll-Header.Request vor Retry korrigieren.
401 authentication_failedFehlendes, fehlerhaftes, unbekanntes, widerrufenes oder abgelaufenes Bearer Credential.Credential ersetzen.
403 authorization_failedGültiges Credential ohne erforderlichen Scope oder Rolle.Erlaubtes Credential nutzen.
404 not_foundRessource existiert nicht für diese Organisation.ID und Organisationskontext prüfen.
409 idempotency_conflictGleicher Idempotency Key mit anderem Create Request.Ursprünglichen Request wiederverwenden oder neuen Key für neue Arbeit erzeugen.
409 export_not_readyDownload angefragt, bevor Export bereit ist.Export-Ressource pollen, bis downloadReady true ist.
410 export_expiredExport-Artefakt ist nicht mehr downloadbar.Neuen Export erstellen.
413 validation_failedMultipart CSV überschreitet Direct-Upload-Limit.Datei unter 25 MiB reduzieren oder aufteilen.

Spezifische öffentliche Fehlerseiten liegen unter Fehlerreferenz. Generierte Endpoint-Response-Verträge liegen unter API-Referenz.