Vorgehensweise für Dienstleister die Zugriff zu Objekten eines bestimmten ImmobilienScout24-Kunden benötigen
von Sascha Boerger
Dieser Artikel richtet sich an Dienstleister, die von ImmobilienScout24-Kunden beauftragt wurden, eine REST-API-Implementierung zu erstellen und enthält alle Infos und notwendige Schritte dazu.
****************************
UPDATE (Stand 12.08):
- PHP-SDK wurde um 3-beinigem oAuth erweitert, damit müssen Sie Schritt 2 nicht mehr selber programmieren, wenn Sie PHP verwenden. Wir arbeiten mit Hochdruck an einer Datenfreigabe-Website, die vorauss. Mitte September live geht, damit auch alle anderen sich den 3-beinigen oAuth-Prozess für die Freigabe sparen können
- Bug: Exposés die nur homepage-veröffentlicht sind, können derzeit nicht abgerufen werden. Bugfix steht vorauss. am 01.09 zur Verfügung.
- Channel als Filter in der Suche: derzeit liefert die Suche alle Objekte eines Anbieters. Wir werden den Channel (is24-veröffentlicht, homepage-veröffentlicht) auf die Suche anwenden, so dass bei “Channel=hp&username=[username]” nur die Homepage-veröffentlichte Objekte des Auftraggebers ausgegeben werden.
**************************
Mit Ihren API-Zugangsdaten (oAuth-Key/-Secret) können Sie nicht automatisch auf Objekte eines ImmobilienScout24-Kunden zugreifen.
Damit Sie die Objekte eines bestimmten ImmobilienScout24-Kunden verwenden können, müssen Sie:
1. Individuelle Testdaten auf der Sandbox erstellen
2. Ihr Access-Token vom Auftraggeber über 3-beiniges oAuth freigeben lassen.
3. In der Suche den Query-Parameter „channel=hp“ verwenden. Doku
Zu 1.
In der Sandbox befinden sich nur allgemeine Testobjekte, also nicht die Objekte Ihres Auftraggebers. Sie haben 2 Möglichkeiten:
- Sie programmieren Ihr Projekt vorerst ohne den “channel=hp&username=xxx”, fordern einen Produktivkey an und fügen dann den Channel ein, oder
- Sie legen selber einen Account mit Objekten in der Sandbox an. Das geht wie folgt:
- Sie buchen über http://sandbox.immobilienscout24.de/de/anbieten/geschaeftsportal/profipakete/produkt-basiszugangplus.jsp ein Produkt
- Nach der Registrierung können Sie Objekte anlegen und veröffentlichen diese unter “immobilienscout24”.
Die Sandbox ist ein geschlossenes Testsystem: sämtliche Buchungen, Veröffentlichungen gelten nur in der Sandbox und lösen somit keine echte Buchungen aus. Es werden auch keine Kontakt-E-Mails generiert.
Zu 2.
Ab sofort steht das PHP-SDK inkl. 3-beinigem oAuth zur Verfügung, so dass PHP-Anwender die Freigabe darüber laufen lassen können.
Nicht PHP-Anwender müssen sich noch bis Mitte September gedulden: dann werden wir eine Datenfreigabewebsite zur Verfügung stellen. Bis dahin müssen Sie die Freigabe wie folgt umsetzen:
- Sie benötigen ein kleines Webformular, mit dem Sie mit Ihrem Testaccount bzw. Ihr Auftraggeber den 3-beinigen oAuth-Dialog aufrufen (Wiki: siehe Flußdiagramm zwischen Punkt 2 und 3).
- Der Auftraggeber wird dann aufgefordert, sich mit seinen ImmobilienScout24-Logindaten einzuloggen.
- Er bekommt im Folge-Dialog die Aufforderung, Ihrem „System“ den Zugang zu seinem Account zu gewähren. Der Vorgang endet dann in einer Bestätigung.
Nach diesem Prozess haben Sie mit channel=hp Zugriff auf die Objektdaten Ihres Testaccounts/Ihres Auftraggebers. Derzeit auf alle Objekte, ab 01.09 wird der Veröffentlichungsstatus berücksichtigt und wurden mit channel=hp nur noch die Objekten mit Veröffentlichungsstatus „Firmenprofil / Homepage“ ausgegeben.
Zu 3.
Ein search request mit „Deutschland“ als Beispielregion für Ihrem neu angelegten Account würde dann so aussehen:
http://sandbox.immobilienscout24.de/restapi/api/search/v1.0/search/region?realestatetype=apartmentrent&geocodes=1276&channel=hp&username=[Benutzername]
Es gibt eine GoogleUserGroup zu unserer REST-API, in der Sie Fragen stellen können.
Bitte haben Sie Verständnis dafür, dass wir Sie nicht aktiv bei der Umsetzung unterstützen können. Anregungen/Fragen zu dieser Anleitung können Sie als Kommentar posten oder mailen an restapi@immobilienscout24.de.
****************************
Wir wünschen Ihnen viel Erfolg!
