Zum Hauptinhalt springen

Wie Fehler gemeldet werden

Jeder Fehler der Sally API nutzt denselben JSON-Body, ein Fehler-Handler reicht also. Diese Seite zeigt diesen Body und was jeder Statuscode für deine Anbindung bedeutet.

{
  "statusCode": 429,
  "message": "Transcription quota exhausted.",
  "code": "FUP_LIMIT_EXCEEDED"
}

Schnellnavigation

  1. Der Fehler-Body
  2. Die Statuscodes
  3. 403 und 404 bedeuten Verschiedenes

1. Der Fehler-Body​

code ist eine stabile, maschinenlesbare Kennung. Sie steht nur bei Fehlern, die eine eigene Reaktion verdienen, etwa FUP_LIMIT_EXCEEDED oder TOO_MANY_CONCURRENT_TRANSCRIPTIONS. Allgemeine Fehler lassen sie weg. Verzweige also auf code, wenn er da ist, sonst auf statusCode.

2. Die Statuscodes​

CodeBedeutung
400Die Anfrage ist ungültig: Body, Query oder Pfad haben die Prüfung nicht bestanden.
401Das Bearer-Token fehlt oder ist nicht mehr gültig.
403Du siehst die Ressource, aber die Operation verlangt eine höhere Rolle, etwa Admin oder Owner.
404Nicht gefunden oder für dich nicht sichtbar.
409Konflikt, etwa beim Einladen einer Person, die schon Mitglied oder bereits eingeladen ist.
429Rate-Limit überschritten, bei Uploads auch die Fair-Usage-Grenze. Hier lohnt der Blick auf code.
500Interner Serverfehler. Später erneut zu versuchen ist sinnvoll.

3. 403 und 404 bedeuten Verschiedenes​

Das heißt

Ein 403 sagt dir, dass die Ressource existiert und deine Rolle zu niedrig ist, was ein Mensch beheben kann. Ein 404 sagt dir absichtlich nichts: Nicht gefunden und nicht sichtbar sind bewusst nicht unterscheidbar, damit eine Antwort nie verrät, dass es Daten gibt. Warum ein Token sieht, was es sieht, erklärt Authentifizierung.