Eltérés az ApiV3-hoz képest
Ami minden entitásra közösen más. Az entitás saját eltérése a lapja végén áll („A régi API-ból”), a mező régi neve a mezőtábla Régi oszlopában.
| ApiV3 | Új | |
|---|---|---|
| a cím | https://api.capitris.hu/v3/api/{régi ügyfélkód}/{entitás}/{művelet} |
https://connect.adertis.hu/{ügyfélkód}/api/{entitás}/{művelet} — A cím |
| az ügyfélkód | a régi ügyfélkód | az ADERTIS helpdesktől kapott kód; eltérhet a régitől |
| a kulcs | a query-stringben: ?api_key= |
az X-API-Key fejlécben; a query-stringben nem fogadja |
| az írás | GET vagy POST, a mezők a törzsben vagy a query-stringben |
csak POST, a mezők csak a törzsben — A kérés |
| az ismeretlen és a csak olvasható mező | figyelmen kívül hagyja | 400 — Az értékek |
| az üres érték a válaszban | többnyire "" vagy 0 |
null — Az értékek |
| az entitás neve | egyes szám: user, list, listitem |
többes szám: users, lists, listitems |
| a mezők neve | kisbetűs: folderid, allow_disabled |
camelCase: folderId, allowDisabled — A nevek |
| a siker | 200, a válaszban "status": "ok" |
2xx, status mező nélkül — A válasz |
| a hiba | többnyire 200, { "status": "error", "error": "…" } |
a hiba HTTP-státusza és { "error": { "code", "message", "fields" } } — Hibák |
| a rekord a válaszban | egy kulcs alatt: { "status": "ok", "user": { … } } |
a gyökérben |
| a létrehozás válasza | { "status": "ok", "id": … } |
201 + { "id": … }, Location fejléccel |
| a dátum | 2026.10.17 10:00:00 |
ISO 8601, de a régi formátum is beállítható — Dátum |
| a lapozás | offset + limit, legfeljebb 5000 |
after + limit, legfeljebb 5000, a válaszban hasMore — A lapozás |