Salt la conținutul principal
O cheie API lucrează în numele unui cont și are acces exact la anunțurile pe care contul le gestionează în portalul Housera. Pagina spune ce înseamnă asta pentru fiecare rol, pentru cheia din contul propriu și pentru legătura dată unui integrator. În paginile acestea, „firma” e entitatea de care e legată o cheie sau o legătură: agenția sau dezvoltatorul imobiliar în care lucrează contul. „Agenție” numește doar tipul de cont.

Două feluri de chei

Cheia proprie o creează contul din Setări → API și o folosește în sistemul lui. Așa lucrează o persoană fizică, o agenție cu aplicația ei sau un dezvoltator imobiliar. Legătura unui integrator apare când contul acceptă un CRM prin Conectează cu Housera. Integratorul primește o cheie API legată de aplicația lui. Contul vede legătura în Setări → API, la Aplicații conectate, și o poate revoca de acolo oricând. Orice cheie e legată de o firmă: firma în care lucrează contul, la crearea cheii proprii sau la acordul dat unui integrator. Un cont fără firmă are chei fără firmă. API-ul scrie și citește doar în firma cheii.

După rolul contului

Pentru un anunț la care cheia nu are acces, API-ul răspunde 404 not_found, la fel ca pentru unul care nu există. Regula e aceeași pe listă, la citire, la editare, la poze și la schimbările de stare. Evenimentele unui anunț (GET /events și webhook-urile) ajung la agentul care îl are și la titularul și administratorii firmei, fiecare cu cheia lui. Un manager de punct de lucru vede anunțurile punctului său în listă, dar evenimentele lor nu ajung la el. Evenimentele unui anunț șters rămân în firma lui. Un anunț mutat pe alt agent din portal rămâne accesibil titularului și administratorilor, deci și legăturilor lor. Doar agentul care l-a avut nu mai are acces la el.

Firma suspendată sau închisă

Cât timp firma cheii e suspendată, cheia nu mai vede echipa. Titularul, administratorii și managerii rămân cu anunțurile și cererile clienților pe care le au ei în grijă, ca în portal, iar evenimentele despre anunțurile și cererile colegilor nu le mai ajung. După reactivare, accesul revine fără să faci nimic. Când firma se închide, membrii ies din ea: cheia rămâne cu anunțurile contului, ascunse odată cu firma, și cu cererile lui din afara firmei. O cheie nouă nu se poate lega de o firmă suspendată sau închisă.

Un cont, o firmă

Un cont de firmă lucrează într-o singură firmă. Cine lucrează pentru două firme are două conturi, fiecare cu adresa lui de email și cu cheile lui. Pagina Setări → API arată firma pe fiecare cheie. Când omul pleacă din firmă, cheile legate de ea primesc 401 unauthenticated. Nu ajung nici în firma în care contul intră după aceea: acolo își face o cheie nouă.

Id-urile tale (external_ref)

Spațiul în care un external_ref e unic urmează rolul:
  • pentru titular și administratori, id-ul e unic în firmă: un CRM al firmei scrie pentru toți;
  • pentru un agent sau un manager, id-ul e unic în spațiul lui, separat de al colegilor;
  • pentru un cont fără firmă, id-ul e unic în cont;
  • un integrator are mereu id-urile lui, separate de cele ale contului și ale altor integratori.
În răspunsuri și în evenimente, external_ref îl vede doar o cheie din spațiul în care a fost pus, adică una care l-ar găsi cu GET /account/listings/ref/{ref}. Pentru celelalte chei (cheia proprie a contului, legătura altui integrator, cheia unui coleg cu alt spațiu) câmpul e null. Detaliile sunt în Identificatori.

Cererile clienților

Cu dreptul leads:read, o cheie citește cererile clienților pe care contul le vede în portal. Titularul și administratorii citesc cererile întregii firme, managerul pe cele ale punctului său de lucru, iar agentul pe cele pe care le are în grijă. Vezi Cererile clienților.

Ansamblurile și parteneriatele

O cheie leagă unități doar de ansamblurile firmei ei și de ansamblurile firmelor care au aprobat-o ca parteneră. Un parteneriat îl cere titularul sau un administrator al agenției. Pe partea ansamblului decid titularul, un administrator sau managerul proiectului. Cheia altui membru primește 404. Evenimentele unui parteneriat (partnership.*) și ale unui mandat (complex.*) ajung doar la cheile legate de firma pe care o privesc, ale titularului și administratorilor ei. După ce dezvoltatorul preia un ansamblu, ansamblul nu mai e al agenției: cheile ei primesc 404 pe el, ca pe anunțul oricărei alte firme. Vezi Agențiile partenere și Proiectele dezvoltatorului.

Ce nu dă nicio cheie

  • Catalogul platformei (GET /listings) cere dreptul catalog:read, pe care îl acordă doar Housera.
  • O cheie nu poate face ce contul nu poate face în portal. Un cont de agenție nu publică ansambluri rezidențiale, iar o firmă neaprobată nu publică până la aprobare.