Zum Inhalt springen

ecentic API: Fehler.

Jeder Fehler in der ecentic API ist ein typisiertes Problemdokument, keine HTML-Seite. Der Code ist der Vertrag: stabil, maschinenlesbar und sicher für Verzweigungen nutzbar.

RFC 9457 · Stabile Codes · Hinweise zur Behebung

01

Die Struktur eines Problems

Ein Medientyp, ein Schema – bei jedem 4xx- und 5xx-Fehler, den die API zurückgibt.

application/problem+json

Antworten enthalten Content-Type: application/problem+json – bewusst nicht application/json, weil der Medientyp einem generischen Client signalisiert, dass der Body einen Fehler beschreibt und nicht die angeforderte Ressource.

Beispielantwort

Antwort lesen

type
Die URI, die das Problem bezeichnet und in dieser Referenz verankert ist.
code
Die stabile Kennung, anhand der Ihr Client unterschiedliche Abläufe steuern kann.
title
Eine kurze, für Menschen lesbare Zusammenfassung.
status
Der HTTP-Status, der im Body wiederholt wird.
detail
Was bei dieser konkreten Anfrage schiefgelaufen ist.
resolution
Der nächste Schritt zur Behebung des Fehlers.
Dokumentation
Die Referenzseite für die Antwort.
Instanz
Der Anfragepfad, der sie erzeugt hat, sofern bekannt.
02

Fehlerkatalog

Codes werden nach ihrer Veröffentlichung eingefroren. Titel und Hinweise können umformuliert werden, Codes nicht.

12Veröffentlichte Fehlercodes

Öffnen Sie einen Code, um die Lösung zu lesen. Jeder Code hat einen permanenten Link.

Permanenter Link zu not-found

So beheben Sie das Problem

Check the path against the OpenAPI document at /openapi.json or the API catalog at /.well-known/api-catalog.

Permanenter Link zu method-not-allowed

Permanenter Link zu unauthenticated

Permanenter Link zu unauthorized

Permanenter Link zu payment-required

Permanenter Link zu subscription-required

Permanenter Link zu invalid-request

Permanenter Link zu validation-failed

Permanenter Link zu conflict

Permanenter Link zu rate-limited

Permanenter Link zu upstream-timeout

Permanenter Link zu internal-error