Concepte
Acest capitol definește termenii folosiți în documentația API Imopedia.ro.
Agenție
Agenția este contul autorizat să publice oferte prin API. ID-ul agenției este comunicat de echipa Imopedia împreună cu datele de acces și se transmite în câmpul AGENTIA.
Agent
Agentul reprezintă persoana de contact asociată unei oferte. Datele agentului pot fi gestionate prin operațiile dedicate agenților sau transmise direct pe ofertă prin câmpuri precum CONTACT_PERS, CONTACT_TEL și CONTACT_EMAIL.
Ofertă
Oferta este proprietatea publicată în Imopedia.ro. Ea este creată sau actualizată prin saveProperty și este descrisă prin câmpuri precum tipul imobilului, tranzacția, prețul, localizarea și detaliile de contact.
ID_LOCAL
ID_LOCAL este identificatorul numeric canonic al ofertei folosit de API în contextul agenției. Pentru sincronizare corectă, aceeași ofertă trebuie retrimisă cu același ID_LOCAL.
Pentru integrări în care CRM-ul are deja un ID numeric stabil, trimite acel ID în ID_LOCAL la saveProperty. La acea apelare și la următoarele, API-ul îl va trata ca identificator unic al ofertei pentru agenție.
Dacă CRM-ul folosește ID-uri alfanumerice, UUID-uri sau nu are încă un ID numeric stabil, la creare omite ID_LOCAL (sau trimite doar un ID numeric stabil dacă există). API-ul alocă un ID_LOCAL numeric. Salvează result.ID_LOCAL din răspunsul saveProperty și trimite-l la toate operațiile ulterioare (saveProperty update, media, ștergere, promovare).
Dacă ai un ID CRM nestandard, păstrează-l separat în sistemul tău și folosește ID_LOCAL returnat de API pentru operațiile SOAP. Nu trimite ID-uri alfanumerice direct în câmpurile care cer ID_LOCAL numeric.
Acesta este identificatorul pe care îl folosești și în apelurile care lucrează cu oferta în contextul agenției, de exemplu saveBoost, unde parametrul offerId înseamnă ID_LOCAL.
property_id
property_id este identificatorul intern Imopedia returnat de unele răspunsuri, de exemplu după saveProperty. Nu îl înlocuiește pe ID_LOCAL în payload-urile de sincronizare și nu se trimite ca offerId la saveBoost.
Pentru integrare, persistă ID_LOCAL numeric. Tratează property_id doar ca referință internă sau diagnostică, nu ca identificator operațional al ofertei în API.
URL public al ofertei
Pentru o ofertă publicată în Imopedia.ro, URL-ul public se construiește din AGENTIA și ID_LOCAL:
https://www.imopedia.ro/anunt/proprietate-{AGENTIA}RUN{ID_LOCAL}
Exemplu cu valori fictive:
https://www.imopedia.ro/anunt/proprietate-123RUN67654
Nu folosi property_id pentru construirea URL-ului public. property_id este o referință internă returnată de API, în timp ce linkul public folosește perechea AGENTIA + ID_LOCAL.
După saveProperty, oferta poate avea nevoie de procesare, validare sau indexare înainte să fie vizibilă public. Construirea URL-ului nu garantează că pagina este accesibilă imediat.
Pentru integrare, tratează identificatorii astfel:
| Identificator | Cine îl stabilește | Unde se folosește |
|---|---|---|
ID_LOCAL |
Sistemul partenerului sau API, dacă CRM-ul nu trimite un număr valid | saveProperty, media, sincronizare, saveBoost ca offerId și URL public împreună cu AGENTIA |
property_id |
Imopedia | Referință internă returnată de API; nu este offerId și nu se folosește în URL-ul public |
AGENTIA
AGENTIA este ID-ul agenției autorizate pentru publicare. Valoarea este necesară pentru asocierea datelor trimise cu contul corect.
Sesiune
Sesiunea începe prin login, care returnează un session_id. Acest identificator trebuie transmis în apelurile ulterioare și sesiunea trebuie închisă prin logout.
Fișier media
Un fișier media este o imagine sau o resursă asociată unei oferte. Fișierele sunt verificate prin existsFile, încărcate prin addFile și sincronizate prin syncFiles.
Nomenclator
Un nomenclator este o listă controlată de valori acceptate pentru anumite câmpuri. Pentru implementare, folosește nomenclatoarele versionate din Nomenclatoare.