Ein Statuscode in APIs ist die dreistellige Zahl, mit der eine Schnittstelle zu jeder Antwort sagt, ob die Anfrage geklappt hat. Es sind dieselben Codes wie bei gewöhnlichen Webseiten, bei einer Schnittstelle tragen sie aber mehr Bedeutung, weil ein Programm darauf reagiert und kein Mensch.
- Statuscode in APIs
Der Zahlencode im Kopf einer API-Antwort, an dem ein Programm Erfolg, Fehler des Aufrufers oder Fehler des Servers erkennt.
Beispiel: „Weil der Statuscode in der API-Antwort einen Fehler des Aufrufers meldete, hat das Formular die Eingabe zurückgewiesen.“Verwandt: HTTP-Statuscodes, die vollständige Übersicht über die Codes und ihre Klassen.
Die wichtigsten Statuscodes in APIs
200 heißt Erfolg, 201 Erfolg mit neu angelegtem Datensatz, 204 Erfolg ohne Inhalt. 400 meldet eine fehlerhafte Anfrage, 401 eine fehlende Anmeldung, 403 fehlende Rechte, 404 eine unbekannte Ressource und 422 Daten, die die Prüfung nicht bestanden haben.
429 sagt, dass zu viele Anfragen kamen, mehr dazu unter Rate Limiting. Alles ab 500 ist ein Fehler auf Seiten des Servers.
Warum der richtige Statuscode zählt
Programme entscheiden anhand des Codes, was sie tun. Bei 401 melden sie sich neu an, bei 429 warten sie, bei 503 versuchen sie es später noch einmal. Eine Schnittstelle, die jeden Fehler mit 200 und einer Meldung im Text beantwortet, bringt diese Logik durcheinander.
Statuscode und Fehlermeldung zusammen
Der Code sagt, welche Art Fehler vorliegt, die Meldung im Body sagt, was genau. Für Fehler bei der Prüfung von Eingaben gehört dazu, welches Feld betroffen ist, damit eine Oberfläche den Hinweis an der richtigen Stelle zeigen kann.
Ein verbreitetes Format dafür ist Problem Details nach RFC 9457, das Typ, Titel und Beschreibung eines Fehlers als JSON festlegt.