Ingatlan REST-interfész: végpontok és válaszok
A portál-oldali ingatlan REST-végpontok: hitelesítés API-kulccsal, funkciójog, lista, adatlap, kép, a válasz szerkezete és a hibakódok.
A portál-oldali ingatlan-interfész három olvasó REST-végpontot ad külső rendszereknek. Saját táblája nincs; az ingatlan-törzset és a dokumentumtárat a portál-oldali modelleken át olvassa. Az OpenAPI-leírást a központi API-böngésző kapja (címke: property).
Végpontok
| Útvonal | Művelet | Paraméterek |
|---|---|---|
GET /masterdata/property | listProperties | since (ÉÉÉÉ-HH-NN ÓÓ:PP:MM), page (alap 1), limit (alap 100, max. 500) |
GET /masterdata/property/{property_id} | getProperty | ingatlan-azonosító |
GET /masterdata/property/{property_id}/image/{doc_id} | getPropertyImage | ingatlan- és dokumentum-azonosító |
Folyamat
- Kapu minden végponton: az API-kulcs (fejléc
X-Oc-Api-Key) felhasználóra oldódik; érvénytelen kulcsnál „Invalid or missing API key.” (UNAUTHORIZED, 401) és figyelmeztető naplósor. - Funkciójog a kulcs felhasználójára:
masterdata/property+export; hiányában „Permission denied.” (PERMISSION_DENIED, 403). - Lista: a
sincea módosítás, ennek híján a létrehozás idejére szűr. Válasz:properties[]= azonosító, saját azonosító, státusz, módosítás dátuma. Státusz szerint nem szűr. - Adatlap: az export-alak (
Dlbtproperty::exportShape()): típusok, hasznosítások, nyelvenkénti szövegek, cím, geo-koordináta, számadatok (nettó, bruttó, telek terület, szobák, félszobák, építési év, emelet, épületszintek), részletek (a visszavont hirdetési mezők nélkül), helyiségek, szintösszesítés, közmű-mérők, áruházak, média. A média elemei: azonosító, szerep, név, kiterjesztés, SHA-256; képnél sorrend és letöltési URL. Csak a kulcs felhasználójának API-hatókörébe eső cég dokumentumai. Nem létező ingatlan: „The property was not found.” (NOT_FOUND, 404). - Kép: csak az ingatlanhoz kötött, kép kiterjesztésű, hatókörön belüli dokumentum; JPEG, legfeljebb 2048 px,
Cache-Control: private, max-age=3600. EgyébkéntNOT_FOUND.
Hibánál a közös REST-boríték: success:false, error, error_code, a HTTP-státusz a kódból; kivételnél DB_QUERY_ERROR (500).
Jogosultság
- Alap hozzáférés: portál-oldali útvonal, érvényes API-kulccsal.
- Funkciójog:
masterdata/propertyexporta kulcs felhasználójára. - Tartalmi hatókör: a dokumentumokra és képekre az API-hatókör (a dokumentum cége). Az ingatlan szöveges és számadatai cég-hatókör nélkül adódnak ki.
Ismert korlátok
Hirdetési portálokhoz (például ingatlanportálok, OpenImmo-formátum) készülő átadók a kódban nincsenek, külön feladatként szerepelnek. Az admin felületi ingatlan-export ugyanezt az alakot adja, a képek URL-je nélkül.