Virheet
Virhevastaukset
Fenerum API käyttää standardeja HTTP-tilakoodeja ilmoittamaan API-pyynnön onnistumisesta tai epäonnistumisesta.
HTTP-tilakoodit
- 2xx - Onnistui: Pyyntö onnistui
- 4xx - Asiakasvirhe: Pyynnössä oli virhe (esim. puuttuvat parametrit, autentikoinnin epäonnistuminen)
- 5xx - Palvelinvirhe: Jotain meni pieleen Fenerumin palvelimilla
Yleiset tilakoodit
| Status Code | Merkitys |
|---|---|
| 200 | OK - Pyyntö onnistui |
| 201 | Created - Resurssi luotiin onnistuneesti |
| 204 | No Content - Pyyntö onnistui ilman vastaussisältöä |
| 400 | Bad Request - Virheelliset pyyntöparametrit |
| 401 | Unauthorized - Autentikointi epäonnistui tai puuttuu |
| 403 | Forbidden - Autentikoitu, mutta ei valtuutettu |
| 404 | Not Found - Resurssia ei ole olemassa |
| 429 | Too Many Requests - Pyyntöraja ylitetty |
| 500 | Internal Server Error - Jotain meni pieleen palvelussamme |
Virhevastausten muoto
Kun virhe tapahtuu, API palauttaa JSON-objektin, jossa on lisätietoja:
{
"detail": "Error description",
"field_name": ["Specific field error messages"]
}Kenttäkohtaiset virheet
Validointivirheissä vastaus sisältää kenttäkohtaiset virheilmoitukset:
{
"email": ["This field is required."],
"amount": ["Ensure this value is greater than or equal to 0."]
}Parhaat käytännöt
- Tarkista aina HTTP-tilakoodi ennen vastauksen jäsentämistä
- Lokita virhevastaukset vianmääritystä varten
- Käsittele rate limiting -virheet eksponentiaalisella backoffilla
- Näytä käyttäjäystävälliset viestit validointivirheistä