Úvod
API slúži na validáciu maklérov a zákaziek v rámci systému UC platformy pre Realsoft. Validácia prebieha formou metódy POST na URL https://plt.unitedclassifieds.sk/import/api/v1/realsoft/validation
.
Pre zjednodušenie zadávania vstupu je možné využiť swagger.
caution
API je momentálne určená len na testovacie účely, nie je žiaduce, aby sa na testovanie posielali naraz stovky inzerátov.
Maximálna doba spracovania je 1 minúta.
V prípade, keď sa Vám nevráti odpoveď, pošlite prosím menej inzerátov.
Vstupné dáta#
Vstupné dáta sú pole hodnôt typu OfficeData. Typy v hranatých zátvorkách []
sú polia daného typu.
Základná štruktúra#
- OfficeData - hierarchicky najvyššia trieda, spája pobočku a maklérov
- Office - obsahuje dáta o pobočke
- [UserData] - spája makléra s inzerátmi
- User - obsahuje dáta o maklérovi
- [Advertisement] - hlavný pilier celej schémy, obsahuje data o inzeráte
- GeoPoint - obsahuje GPS súradnice
- Extra - extra parametre obsahujú dodatočné údaje ako napríkald plochu terasy, balkónu a podobne
- MultiExtra - rozšírenie extra parametrov v prípade, ak je nutné definovať napríklad rozmery dvoch balkónov
- Location - lokalita inzerátu, hojne využíva číselníky
- [Image] - obrázky inzerátu
tip
Ak neviete nájsť Váš parameter v Advertisement štruktúre, skúste sa pozrieť do Extra parametrov. Tie obsahujú viac špecializované parametre.
Dáta pri importe#
Import prebieha automaticky v následujúcom intervale:
Typ súboru | Časový interval importu |
---|---|
Súbor, ktorý obsahuje celú inzerciu a používateľov | každých 12 hodín |
Príklad vstupných dát#
Výstupné dáta#
Je možné dostať dva rôzne výstupy:
200
- Data is ok (dáta sú v poriadku)422
- The data is not correct according to the scheme. (dáta nie sú v správnom tvare)
Príklad výstupu pri nesprávnych dátach:#
Schéma#
OpenAPI schéma vyzerá takto: