© saicle/Shutterstock.com
PHP Magazin
Auf Wohnungssuche mit dem ImmobilienScout24-API

Auf Wohnungssuche mit dem ImmobilienScout24-API

Täglich erscheinen neue Apps, Mash-ups und Microsites, die mithilfe von bereitgestellten Daten neue innovative Lösungen entwickeln. Seit einiger Zeit setzt auch der Marktführer rund um Immobilien, ImmobilienScout24, auf diesen Trend und stellt ein Rest-API zur Verfügung, mit dem auf den Objektbestand des Immobilienportals zugegriffen werden kann. Zeit, auf Wohnungssuche zu gehen.

Norman Braun


Um die Arbeit mit der Schnittstelle so einfach wie möglich zu gestalten, stellt Immocaster das offizielle PHP-SDK für dieses API zur Verfügung. Das SDK kann kostenlos von der Immocaster-Website heruntergeladen werden und stellt die wichtigsten Funktionen bereit.

Vorbereitung

Bevor mit der eigentlichen Arbeit begonnen werden kann, müssen zwei Dinge vorhanden sein: Als Erstes muss das SDK von Immocaster [1] heruntergeladen werden. Als zweites benötigt man einen API-Key/Secret [2] für die Schnittstelle von ImmobilienScout24, welcher einem die Erlaubnis erteilt, auf die Daten von ImmobilienScout24 zugreifen zu dürfen. Letzteres erhält man kostenlos auf der Developer-Website von Immobilien­Scout24 [3].

Einrichtung

Vor der ersten Abfrage muss das SDK natürlich erst einmal mit dem API von ImmobilienScout24 verbunden werden. Dazu wird einfach die Datei sdk.php geladen und eine Instanz des Objekts Immocaster_Sdk erzeugt. Der erste Parameter bei der Instanziierung ist der Namespace, der frei gewählt werden kann. Die Values 'KEY' und 'SECRET' müssen natürlich mit dem jeweiligen Key und Secret ersetzt werden, die man von ImmobilienScout24 erhält. Wichtig ist auch das Umschalten auf das Live-API von ImmobilienScout24, da Immocaster als Standard die Sandbox nutzt. Außerdem sollte zum Übertragen der Daten cURL aktiviert werden. Das folgende Beispiel zeigt, wie die Verbindung mit dem API von ImmobilienScout24 hergestellt wird:

require_once('Immocaster/Sdk.php');$oImmocaster = Immocaster_Sdk::getInstance('is24','KEY','SECRET');$oImmocaster->setRequestUrl('live');$oImmocaster->setReadingType('curl');

Regionen abfragen

Nachdem die Einrichtung abgeschlossen ist, können die Daten des API abgefragt werden. Bevor man allerdings komplette Ergebnislisten für eine Region wie zum Beispiel Berlin abfragt, benötigt man die geoCodeId für diese Region. Sie kann ebenfalls über das API ermittelt werden:

$aParameter = array('q'=>'Ber');$res = $oImmocaster->getRegions($aParameter);

Als Rückgabe erhält man bei Angabe des Wertes „Ber“ für den Parameter q eine Liste mit allen Regionen die mit „Ber“ beginnen (Berlin, Berlin-Kreuzberg …). Diese Liste enthält neben dem Namen der Region auch die geoCodeId und die Anzahl der gefundenen Objekte in dieser Region.

Immobiliendaten auslesen

Nachdem man die ID für Berlin ermittelt hat (1276003001), können die Objekte der Region ausgelesen werden. Im Folgenden wird gezeigt, wie man eine Liste für eine Region aller Mietwohnungen ausliest:

$aParameter = array( 'geo...

PHP Magazin
Auf Wohnungssuche mit dem ImmobilienScout24-API

Auf Wohnungssuche mit dem ImmobilienScout24-API

Täglich erscheinen neue Apps, Mash-ups und Microsites, die mithilfe von bereitgestellten Daten neue innovative Lösungen entwickeln. Seit einiger Zeit setzt auch der Marktführer rund um Immobilien, ImmobilienScout24, auf diesen Trend und stellt ein Rest-API zur Verfügung, mit dem auf den Objektbestand des Immobilienportals zugegriffen werden kann. Zeit, auf Wohnungssuche zu gehen.

Norman Braun


Um die Arbeit mit der Schnittstelle so einfach wie möglich zu gestalten, stellt Immocaster das offizielle PHP-SDK für dieses API zur Verfügung. Das SDK kann kostenlos von der Immocaster-Website heruntergeladen werden und stellt die wichtigsten Funktionen bereit.

Vorbereitung

Bevor mit der eigentlichen Arbeit begonnen werden kann, müssen zwei Dinge vorhanden sein: Als Erstes muss das SDK von Immocaster [1] heruntergeladen werden. Als zweites benötigt man einen API-Key/Secret [2] für die Schnittstelle von ImmobilienScout24, welcher einem die Erlaubnis erteilt, auf die Daten von ImmobilienScout24 zugreifen zu dürfen. Letzteres erhält man kostenlos auf der Developer-Website von Immobilien­Scout24 [3].

Einrichtung

Vor der ersten Abfrage muss das SDK natürlich erst einmal mit dem API von ImmobilienScout24 verbunden werden. Dazu wird einfach die Datei sdk.php geladen und eine Instanz des Objekts Immocaster_Sdk erzeugt. Der erste Parameter bei der Instanziierung ist der Namespace, der frei gewählt werden kann. Die Values 'KEY' und 'SECRET' müssen natürlich mit dem jeweiligen Key und Secret ersetzt werden, die man von ImmobilienScout24 erhält. Wichtig ist auch das Umschalten auf das Live-API von ImmobilienScout24, da Immocaster als Standard die Sandbox nutzt. Außerdem sollte zum Übertragen der Daten cURL aktiviert werden. Das folgende Beispiel zeigt, wie die Verbindung mit dem API von ImmobilienScout24 hergestellt wird:

require_once('Immocaster/Sdk.php');$oImmocaster = Immocaster_Sdk::getInstance('is24','KEY','SECRET');$oImmocaster->setRequestUrl('live');$oImmocaster->setReadingType('curl');

Regionen abfragen

Nachdem die Einrichtung abgeschlossen ist, können die Daten des API abgefragt werden. Bevor man allerdings komplette Ergebnislisten für eine Region wie zum Beispiel Berlin abfragt, benötigt man die geoCodeId für diese Region. Sie kann ebenfalls über das API ermittelt werden:

$aParameter = array('q'=>'Ber');$res = $oImmocaster->getRegions($aParameter);

Als Rückgabe erhält man bei Angabe des Wertes „Ber“ für den Parameter q eine Liste mit allen Regionen die mit „Ber“ beginnen (Berlin, Berlin-Kreuzberg …). Diese Liste enthält neben dem Namen der Region auch die geoCodeId und die Anzahl der gefundenen Objekte in dieser Region.

Immobiliendaten auslesen

Nachdem man die ID für Berlin ermittelt hat (1276003001), können die Objekte der Region ausgelesen werden. Im Folgenden wird gezeigt, wie man eine Liste für eine Region aller Mietwohnungen ausliest:

$aParameter = array( 'geo...

Neugierig geworden?


    
Loading...

Angebote für Teams

Für Firmen haben wir individuelle Teamlizenzen. Wir erstellen Ihnen gerne ein passendes Angebot.

Das Library-Modell:
IP-Zugang

Das Company-Modell:
Domain-Zugang