API-hibák kezelése
A sikeres válasz feldolgozása előtt ellenőrizze a HTTP-státuszt. A v2 a várt kérési hibákhoz error objektumot küld, benne stabil code értékkel és olvasható message szöveggel.
| Státusz | V2 hibakód | Ellenőrizendő |
|---|---|---|
| 401 | unauthorized | Hiányzó, érvénytelen vagy archivált API-kulcs |
| 403 | forbidden | Szervezeti hozzáférés |
| 404 | not_found | Azonosító, útvonal és a kulcs szervezete |
| 405 | method_not_allowed | HTTP-metódus |
| 422 | invalid_request | Pozitív azonosító, oldalszám és oldalméret |
A hiányzó és a másik szervezethez tartozó rekord egyaránt 404-et ad. Ebből nem állapítható meg, hogy az azonosítót használja-e más szervezet. Az 5xx választ az átjáró vagy a backend is adhatja; nem feltétlenül tartalmaz API-hibaobjektumot. Lekérdezésnél korlátozott számú, késleltetett újrapróbálkozást használjon, és jegyezze fel az időpontot és az útvonalat a hibakereséshez.
A v1 megtartja a meglévő detail válaszát és validációs részleteit. A hibakezelést a meghívott végpont verziójához igazítsa. Időtúllépés után ne ismételjen meg automatikusan v1-hívásindítást: előbb ellenőrizze, létrejött-e a hívás.