Publicatie API [versie 1.3]

Voor de koppeling met de eigen website, kunnen periodiek objecten vanuit HomeSearch via een API uitgelezen worden.

API URL en key

Neem contact op voor de URL, endpoint en API key.

Authenticatie

Header: Authorization: key XXXXXXXX

Als alternatief kan de key ook in de query meegegeven worden ?key=XXXXXXXX.

Algemene opmerkingen

• Alleen woningen met status ‘Te huur’ worden weergegeven
• Alle mogelijke waarden worden altijd meegegeven:
  • Wanneer een waarde “null” heeft, is het niet opgegeven
  • Wanneer een waarde 0 heeft, is het wel opgegeven en betekent het “nee” of “aantal: 0”
• De feed dient periodiek, bijvoorbeeld elk half uur uitgelezen te worden. De feed dient niet real-time ingelezen worden te worden gekoppeld aan een website bezoek. Data dient lokaal opgeslagen te worden.
• Foto’s dienen lokaal opgeslagen te worden. Foto’s dienen eenmalig ingelezen te worden

Output

• Sortering “listings” op basis van “datetime_changed”, DESC (meest recente wijziging bovenaan)
• “datetime_changed”: dit veld is gelijk aan “datetime_changed” van eerste object
• Pagination: op dit moment altijd 1 pagina (dus geen pagination)

Uitleg “listings”

Hieronder wordt een selectie van velden weergegeven.

Veld	Formaat	Uitleg
id	int	Unieke ID per woning. Als een woning opnieuw wordt aangeboden op enig moment, zal ID hetzelfde zijn.
datetime_changed	JJJJ-MM-DD hh:mm:ss Datum en tijd in CET.	Geeft aan wanneer laatste wijziging heeft plaats gevonden. Elke wijziging verandert datum/tijd, bijvoorbeeld: eigenschap veranderen, nieuwe foto uploaden of volgorde foto’s aanpassen.
available_per	int(1)	1: Direct 2: In overleg 5: Datum…
availability_per_date	JJJJ-MM-DD	Alleen van toepassing als available_per: 5
available_for	varchar	tbd: in overleg unlimited: onbeperkt / onbepaalde tijd unlimited-min1yr: idem, met min. 1 jaar [0.25, 0.50, 0.75]: 1, 2, 3 weken [1-24]: getal in aantal maanden 6-12: 6-12 maanden 12-18: 12-18 maanden 18-24: 18-24 maanden
price_period	1	Altijd 1 (= per maand)
property_type		1: Appartement 2: Studio 3: Kamer 4: Maisionette 5: Geheel huis
size		in m2
capacity		in m3
persons		Aantal toegestane personen, inclusief eventuele kinderen
children		Aantal toegestane kinderen
selection_incomerate		Inkomenseis, bruto maandinkomen. Voorbeeld bij waarde 3 en huurprijs van 1200, dan is inkomenseis minimaal 3600 bruto per maand (3 x 1200)
photo		Hoofdfoto
photos	array	Alle foto’s

Velden met aantal, bijv. 2:

• rooms
• bedrooms
• persons
• children
• bathrooms
• toilets
• parkingspots_number

Versie geschiedenis

• 1.3: verplaatst naar support.rently.app
• 1.2: “unlimited-min1yr” toegevoegd als optie
• 1.1: “selection_no-roommates” verwijderd