Fehler nutzen das Format RFC 7807 application/problem+json, sind also einheitlich und maschinenlesbar:
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json
{
"type": "https://docs.grem.capital/api/errors/validation",
"title": "validation",
"status": 400,
"detail": "totalArea (m2) is required",
"requestId": "req_…"
}
Schreiben Sie die requestId immer mit - nennen Sie sie in Anfragen an den Support, damit sich ein Aufruf verfolgen lässt.
Statuscodes
| Status | Bedeutung | Was zu tun ist |
|---|---|---|
400 | Fehler der Prüfung | Korrigieren Sie Körper oder Parameter nach detail. |
401 | Falscher oder fehlender Schlüssel | Prüfen Sie den Kopf Authorization. |
402 | Zu wenig Geld oder Kontingent | Füllen Sie auf oder wechseln Sie den Tarif. |
403 | Fehlender Geltungsbereich | Der Schlüssel ist für dieses Werkzeug nicht freigegeben. |
404 | Nicht gefunden | Falscher Weg, oder die Ressource gibt es nicht. |
409 | Konflikt der Idempotenz | Eine Anfrage mit diesem Idempotency-Key läuft noch. |
422 | Geschäftsregel | Die Anfrage ist gültig, lässt sich so aber nicht ausführen. |
429 | Grenze der Häufigkeit | Warten Sie und wiederholen Sie - siehe Grenzen der Häufigkeit. |
5xx | Fehler des Dienstes | Vorübergehend; wiederholen Sie mit wachsendem Abstand. |
Eine abgelehnte Anfrage (4xx) wird nicht berechnet - die Gebühr je Aufruf fällt nur bei Erfolg an.
Mit Fehlern umgehen
- Verzweigen Sie nach dem numerischen HTTP-
status, nicht nach dem lesbaren Text indetail. - Wiederholen Sie
429und5xxmit wachsendem Abstand; wiederholen Sie4xxnicht (außer409, nachdem die laufende Anfrage fertig ist). - Einzelheiten der Anbieter tauchen in Fehlern nie auf - ein Ausfall erscheint als allgemeiner
provider_error.