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 CodeMerkitys
200OK - Pyyntö onnistui
201Created - Resurssi luotiin onnistuneesti
204No Content - Pyyntö onnistui ilman vastaussisältöä
400Bad Request - Virheelliset pyyntöparametrit
401Unauthorized - Autentikointi epäonnistui tai puuttuu
403Forbidden - Autentikoitu, mutta ei valtuutettu
404Not Found - Resurssia ei ole olemassa
429Too Many Requests - Pyyntöraja ylitetty
500Internal 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ä
background logo

We invoice 2 billion DKK annually for our customers. Let's put your invoicing on autopilot today!