Webmasterinfo
Informationen für Webmaster
Zur Einbindung von ImmoZ in die Website eines Immobilienmaklers
Durch die Einbindung von ImmoZ in die eigene Website kann der Immobilienmakler seinen Kunden gezielt bestimmte Objekte anbieten und eine allgemeine Objektsuche zur Verfügung stellen. Die Anfragen der Kunden werden vom System per E-Mail an den Immobilienmakler übermittelt. Durch diese Einbindung kann der Immobilienmakler seinen Kunden auf Wunsch tausende Objekte (auch als Teilungsgeschäft) anbieten. Die Objekte werden in Echtzeit aktualisiert.
WordPress-Modul
Mit dem ImmoZ-Wordpress-Modul binden Sie die Objektsuche, Objektlisten, Topobjekte oder Objektdetails via Plugin, ganz ohne Programmieraufwand, in Ihre bestehende oder neue WordPress-Website ein.
Das ImmoZ-Wordpress-Modul kann durch den Immobilienmakler unter https://immoz.net/schnittstelle/ bestellt werden.
API
URL
Die Abfrage erfolgt unter folgender Adresse:
API-Key
Die Authentifizierung erfolgt durch Übermittlung eines API-Keys. Dieser Key kann durch den Immobilienmakler unter https://immoz.net/schnittstelle/ bestellt werden.
Der API-Key muss bei allen Abfragen mit request=search im Parameter “api_key” übermittelt werden. Geschieht dies nicht oder wird ein ungültiger API-Key verwendet, meldet die API den Status „404“ und Fehlercode “Not Found?.
Ein- und Ausgabeformat
Alle Ein- und Ausgaben erfolgen UTF-8 kodiert.
Für die Eingabe werden die Parameter als GET-Anfrage übermittelt, andere Anfragen werden mit Status „406“, „Not Acceptable“ beantwortet.
Die Ausgabe erfolgt im OpenImmo-XML-Format, eine fehlerfreie Ausgabe hat den Status „200“.
Dateien
Fotos werden in einer maximalen Auflösung von 1920×1080 px ausgeliefert. Zusätzlich werden Mime-Type und Änderungsdatum mitgeliefert. Sonstige Dateien (PDF, …) werden im Original ausgeliefert.
Parameter
Folgende Parameter können an die API übermittelt werden:
| Parameter | Definition |
|---|---|
| request | Suche: search Version: version Parameterdefinition: info |
| v | OpenImmo-Version, zB. 1.2.7 |
| limit | Anzahl der Ergebnisse, integer, max. 300 |
| page | Seitenangabe für Ergebnisse, 10 Treffer pro Seite, integer, max. 30 |
| objektart | Objektart entsprechend ImmoZ-Vorgabe |
| onr | Objektnummer, integer, im ImmoZ-Format (auch Teile möglich) |
| gesamtflaeche_min | Gesamtfläche, unterster Wert, dezimal |
| gesamtflaeche_max | Gesamtfläche, oberster Wert, dezimal |
| wohnflaeche_min | Wohnfläche, unterster Wert, dezimal |
| wohnflaeche_max | Wohnfläche, oberster Wert, dezimal |
| grundstuecksflaeche_min | Grundstücksfläche, unterster Wert, dezimal |
| grundstuecksflaeche_max | Grundstücksfläche, oberster Wert, dezimal |
| anzahl_zimmer_min | Zimmeranzahl, unterster Wert, integer |
| anzahl_zimmer_max | Zimmeranzahl, oberster Wert, integer |
| kaufpreis_min | Kaufpreis, unterster Wert, dezimal |
| kaufpreis_max | Kaufpreis, oberster Wert, dezimal |
| warmmiete_min | Gesamtmiete, unterster Wert, dezimal |
| warmmiete_max | Gesamtmiete, oberster Wert, dezimal |
| land | Land, 3-stelliges Länderkürzel nach ISO3166 |
| bundesland | Bundesland entsprechend ImmoZ-Vorgabe |
| bezirk | Bezirk entsprechend ImmoZ-Vorgabe |
| stadtlage | Stadtlage entsprechend ImmoZ-Vorgabe, Mehrfachauswahl durch Hinzufügen von [] an den Parameter möglich |
| stadtbezirk | Stadtbezirk entsprechend ImmoZ-Vorgabe, Mehrfachauswahl durch Hinzufügen von [] an den Parameter möglich |
| plz | Postleitzahl |
| ort | Stadt |
| altbau | Altbau, Wert: 1 |
| neubau | Neubau, Wert: 1 |
| bad_wanne | Badezimmer mit Wanne, Wert: 1 |
| maisonette | Maisonette, Wert: 1 |
| lift | Lift vorhanden, Wert: 1 |
| balkon_terrasse | Balkon, Loggia, Terrasse vorhanden, Wert: 1 |
| balkon | Balkon vorhanden, Wert: 1 |
| loggia | Loggia vorhanden, Wert: 1 |
| terrasse | Terrasse vorhanden, Wert: 1 |
| garten | Garten vorhanden, Wert: 1 |
| penthouse | Penthouse, Wert: 1 |
| autoabstellplatz | Autoabstellplatz vorhanden, Wert: 1 |
| foerderung | Förderung vorhanden, Wert: 1 |
| barrierefrei | Objekt ist barrierefrei, Wert: 1 |
| provisionsfrei | Objekt ist provisionsfrei, Wert: 1 |
| wg_geeignet | Für WG geeignet, Wert: 1 |
| own_first | Eigene Objekte zuerst anzeigen, Wert: 1 |
| own | Nur eigene Objekte anzeigen, Wert: 1 |
| foreign | Nur fremde Objekte anzeigen, Wert: 1 |
| project_list | Liste aller (Neubau)Projekte anzeigen – lässt sich beliebig mit anderen Feldern kombinieren, Wert: 1 |
| project_id | Alle Objekte eines (Neubau)Projektes mit der ID project_id anzeigen |