Hibakezelés

A vitalera egészségügyi API szabványos HTTP állapotkódokat használ és strukturált hibaválaszokat ad vissza, hogy segítsen diagnosztizálni és megoldani a problémákat a távoli betegfelügyeleti (RPM) integrációjában. Akár vitális jeleket gyűjt orvosi eszközökről, akár klinikai munkafolyamatokat kezel, a konzisztens hibakezelés megbízható adatcserét biztosít.

Hibaválasz formátuma

Minden hibaválasz konzisztens JSON struktúrát követ:

{
  "detail": "A human-readable description of the error.",
  "code": "error_code"
}

Validációs hibákhoz a válasz mezőszintű részleteket tartalmaz:

{
  "field_name": ["This field is required."],
  "nested_field": {
    "sub_field": ["Ensure this value is greater than 0."]
  }
}

Gyakori HTTP állapotkódok

Ügyfél hibák (4xx)

Kód	Jelentés	Leírás
400	Bad Request	A kérés törzse rosszul formázott vagy hiányoznak kötelező mezők. Ellenőrizze a válasz mezőszintű validációs hibáit.
401	Unauthorized	A hitelesítés sikertelen. A JWT token hiányzik, lejárt vagy érvénytelen.
403	Forbidden	A hitelesített felhasználónak nincs jogosultsága az erőforrás eléréséhez vagy a művelet végrehajtásához.
404	Not Found	A kért erőforrás nem létezik, vagy a felhasználó nem látja.
422	Unprocessable Entity	A kérés jól formázott, de szemantikai hibákat tartalmaz (pl. érvénytelen állapotátmenet, üzleti szabály megsértése).
429	Too Many Requests	Sebességhatár túllépve. Lásd a Sebességkorlátozások oldalt a részletekért.

Szerver hibák (5xx)

Kód	Jelentés	Leírás
500	Internal Server Error	Váratlan hiba történt a szerveren. Ha ez folytatódik, lépjen kapcsolatba a támogatással a kérés azonosítójával.
502	Bad Gateway	Egy downstream szolgáltatás ideiglenesen nem érhető el. Próbálja újra rövid késleltetés után.
503	Service Unavailable	A szolgáltatás karbantartás alatt van. Ellenőrizze a státuszoldalt a frissítésekért.

Hitelesítési hibák

Lejárt token

{
  "detail": "Given token not valid for any token type",
  "code": "token_not_valid"
}

Megoldás: Kérjen új hozzáférési tokent a frissítési tokennel vagy az ügyfél-hitelesítő adatokkal. Lásd a Hitelesítés oldalt.

Hiányzó token

{
  "detail": "Authentication credentials were not provided."
}

Megoldás: Tartalmazzon érvényes JWT tokent az Authorization: Bearer <token> fejlécben.

Validációs hibák

A validációs hibák 400 Bad Request választ adnak mezőspecifikus üzenetekkel:

{
  "status": ["\"invalid\" is not a valid choice."],
  "effective_period_start": ["This field is required."]
}

Megoldás: Javítsa ki a jelzett mezőket és próbálja újra a kérést. Tekintse meg az API referenciát az érvényes mezőértékekért.

Sebességkorlátozási hibák

Amikor túllépi a sebességkorlátot, az API 429 Too Many Requests választ ad:

{
  "detail": "Request was throttled. Expected available in 30 seconds."
}

Megoldás: Várjon a válaszban vagy a Retry-After fejlécben jelzett időtartamot, mielőtt újrapróbálkozna. Lásd a Sebességkorlátozások oldalt a kvóta részleteiért.

Hibaelhárítási tippek

1. Ellenőrizze a válasz törzsét -- a hibaválaszok mindig tartalmaznak ember által olvasható detail üzenetet.
2. Validálja a JWT-t -- használja a jwt.io oldalt a token dekódolásához és a lejárat (exp állítás) ellenőrzéséhez.
3. Ellenőrizze a jogosultságokat -- győződjön meg arról, hogy az alkalmazásának vagy felhasználói szerepkörének hozzáférése van a kért erőforráshoz.
4. Vizsgálja felül a kérés formátumát -- hasonlítsa össze kérését az API referenciapéldáival.
5. Ellenőrizze a sebességkorlátokat -- ha 429 válaszokat kap, valósítson meg exponenciális visszalépést.
6. Lépjen kapcsolatba a támogatással -- tartós 500 hibák esetén lépjen kapcsolatba a support@vitalera.io címmel a kérés időbélyegzőjével és végpontjával.