PHP-SDK-Tutorial

Auf dieser Seite finden Sie Beispiele, wie Sie die PHP-SDK nutzen können.
Sie finden zum Testen diese Beispiele auch in der examples.php im Zip-File der PHP-SDK.
Hinweis: Wenn sie den Api-Key oder Vendor ändern, löschen Sie bitte die Cookies im Browser!!!

Inkludiert die Datei ApiWrapper.php

require_once("ApiWrapper.php");

Array aus dem Api-Key und einem Vendor(Scout-ID/Kundennummer)
Hinweis: Wenn sie mit einer Börse arbeiten, verwenden sie das nächste Access-Array und kommentieren dieses aus oder entfernen es.

$access = array(
'apiKey' = > 'Ihr Freischaltcode/API-Key ',
'vendor' = > '6687764'); //Testvendor: Bitte mit Ihrem ersetzen

Array aus dem Api-Key und einer Vendorgroup (Börsennummer)

$access = array(
'apiKey' = > 'Ihr Freischaltcode/API-Key',
'vendorGroup' = > 'Ihre Börsennummer');

Erzeugt ein neues Objekt der ApiWrapper-Klasse.
Diesem Objekt wird das Access-Array übergeben.
Es wird automatisch die benötigen Sessions der Api erstellt und das Objekt in einer Session gespeichert.
Sie können diese Klasse sofort für Ihre Anfragen benutzen.
Übergabeparameter: access Array aus Api-Key und Vendor oder Vendorgroup

$apiwrapper = new ApiWrapper($access);

Gibt alle Kontinente mit ID und Name als Array zurück

$test = $apiwrapper->getContinents();

Gibt die Länder eines Kontinents als Array zurück. Hier wird der Funktion die uuid des Kontinents übergeben.

$test = $apiwrapper->getCountriesById(1);

Gibt die Bundesländer eines Landes als Array zurück. Hier wird der Funktion die uuid des Landes übergeben.

$test = $apiwrapper->getRegionsById(1276);

Gibt die Bundesländer eines Landes als Array zurück. Hier wird der Funktion die uuid des Landes übergeben.
Zusätzlich wird die Anzahl des übergebenen Immobilientypen je Bundesland zurückgeliefert.
Übergabeparameter: UUID des Landes (Beispiel "1276" für Deutschland)
Übergabeparameter: ImmoType: Immobilie für die eine Statistik gewünscht ist (Beispiel "AppartmentRent")
Hinweis: Immobilientypen finden sie in der technischen Dokumentation.

$test = $apiwrapper->getRegionsStatisticById(1276,'AppartmentRent');

Gibt die Städte eines Bundeslandes als Array zurück. Hier wird der Funktion die uuid des Bundeslandes übergeben.

$test = $apiwrapper->getCitiesByID(1276009);

Gibt die Städte eines Bundeslandes als Array zurück. Hier wird der Funktion die uuid des Bundeslandes übergeben.
Zusätzlich wird die Anzahl des übergebenen Immobilientypen je Stadt zurückgeliefert.
Übergabeparameter: UUID des Bundeslandes (Beispiel "1276009" für Niedersachsen)
Übergabeparameter: ImmoType: Immobilie für die eine Statistik gewünscht ist (Beispiel "AppartmentRent")
Hinweis: Immobilientypen finden sie in der technischen Dokumentation.

$test = $apiwrapper->getCitiesStatisticByID(1276009,'AppartmentRent');

Gibt die Stadtteile einer Stadt/Kreis als Array zurück. Hier wird der Funktion die uuid der Stadt/Kreis übergeben.
Übergabeparameter: UUID der Stadt (Beispiel "1276009017" für Hannover)

$test = $apiwrapper->getQuartersByID(1276009017);

Gibt die Stadtteile einer Stadt/Kreis als Array zurück. Hier wird der Funktion die uuid der Stadt/Kreis übergeben.
Zusätzlich wird die Anzahl des übergebenen Immobilientypen je Stadtteil zurückgeliefert.
Übergabeparameter: UUID der Stadt (Beispiel "1276009017" für Hannover)
Übergabeparameter: ImmoType: Immobilie für die eine Statistik gewünscht ist (Beispiel "HouseBuy")
Hinweis: Immobilientypen finden sie in der technischen Dokumentation.

$test = $apiwrapper->getQuartersStatisticByID(1276009017,'HouseBuy');

Holt ein Array von GeoKoordinaten von der Api und schreibt das Result-Array in die Testvariable.
Übergabeparameter: Stadt, Postleitzahl, (optional) Straße, (optional) Hausnummer
Rückgabewert: Array der GeoKoordinaten, die zu den angegebenen Werten passten

$test = $apiwrapper->getGeoCodeArray('Berlin','10179','Magazinstraße',15);

Holt eine GeoKoordinate von der Api und schreibt sie in die Testvariable.
Achtung: Zur Vereinfachung, wird hier die erste GeoKoordinate ausgegeben.
Dies muss nicht immer die sein, die sie auch haben wollten. Bei einem großen Umkreis kann diese Funktion aber genommen werden.
Für genauere Ergebnisse benutzen sie die Funktion "geoCodeArray".
Übergabeparameter: Stadt, Postleitzahl, (optional) Straße, (optional) Hausnummer

$test = $apiwrapper->getGeoCode('Berlin','10179','Magazinstraße',15);

Gibt alle Immobilien des übergebenen Typs eines Anbieters zurück
Übergabeparameter: Der Immobilientyp der in der Ergebnisliste erscheinen soll
Mögliche Immobilientpyen sind:
AppartmentRent
AppartmentBuy
HouseRent
HouseBuy
Office
Gastronomy
Industry
Store
Misc
Investment
HouseType
WAZ
SiteTrade
SiteLivingRent
SiteLivingBuy
GarageRent
GarageBuy
FlatShareRoom
AssistedLiving
SeniorCare Wohnung Miete
Wohnung Kauf
Haus Miete
Haus kauf
Büro / Praxis
Gastronomie / Hotel
Hallen / Produktion
Einzelhandel
Spezialgewerbe
Gewerbeprojekte
Typenhäuser
Wohnen auf Zeit
Grundstück Gewerbe
Grundstück Wohnen Miete
Grundstück Wohnen Kauf
Garage / Stellplatz Miete
Garage / Stellplatz Kauf
WG-Zimmer
Betreutes Wohnen
Altenpflege

Nachzulesen im File (/common/ImmoType.php)

$test = $apiwrapper->getAllRealEstatesByType('AppartmentRent');

Gibt alle Immobilien der übergebenen Typen im Array eines Anbieters zurück
Übergabeparameter: Array der Immobilientypen, die in der Ergebnisliste erscheinen soll
Als Beispiel werden hier in das Array "types" alle Wohnungen und Hauser zur Miete und zum Kauf eingetragen und übergeben.

$types = array('AppartmentRent','AppartmentBuy','HouseRent','HouseBuy');
$test = $apiwrapper->getAllRealEstatesByTypes($types);

Gibt ALLE Objekte eines Anbieters zurück

$test = $apiwrapper->getAllRealEstates();

Gibt eine individuelle Ergebnisliste der Immobilien eines Anbieters der übergebenen Immobilientypen als Array zurück.
$types ist ein Array von Immobilientypen
$sorting ist ein Array auf SortierungsAttributen als Key und der Sortierungsart als Value
Die Sortierungsattribute und Arten (ASC(absteigend),DESC(aufsteigend) finden sie im File "service/requestService/multiQuery/common/sortTypes.php")
Der allRealEstateStandardRequest Funktion werden folgende Parameter übergeben:

• Die Immobilientypen als Array (welche Typen möglich sind, lesen sie weiter oben)
• Die Seitenzahl (optional-vordefiniert:0), sie bestimmt welche Seite der Ergebnisliste ausgeliefert werden soll. Falls sich die Objekte auf mehrere Seiten aufteilen.
• Die Seitengröße (optional-vordefiniert:30), wie viele Immobilien sich auf einer Seite der Ergebnisliste befinden sollen. (Maximal 50)
• Der Bildtyp (optional-vordefiniert:PictureType::Result) Für Bildtypen siehe ganz oben in diesem Dokument nach oder unter "(service/requestService/common/PictureType.php)")
• Die Sortierung (optional-vordefiniert:absteigend nach PLZ, Stadt, Strasse, Hausnummer) Array von Sortierungen (KEY: Sortierungsattribut / VALUE: Sortierungsart)

$types = array('AppartmentRent','AppartmentBuy');
$sorting = array (SortAttribute::Zip = > SortOrder::ASC,SortAttribute::Heading = > SortOrder::DESC);
$test = $apiwrapper->allRealEstateStandardRequest($types, $pageNumber = 0, $pageSize =
  30,PictureType::Result,$sorting);< /EM>

Nachdem bisher immer alle Objekte eines oder mehrerer Immobilientypen zurückgegeben werden, wird der Request nun feiner um die Immobiliensuche weiter einzuschränken.

Erzeugt ein ResultPage-Objekt.
Die Parameter sind die gleichen, wie im vorherigen Kommentar beschrieben.
Der ImmoType wird allerdings erst später angegeben.

$sorting = array (SortAttribute::Zip => SortOrder::ASC,SortAttribute::Heading = >
  SortOrder::DESC); < /EM >
$resultPage = $apiwrapper->createResultPage($pageNumber = 0,$pageSize =
  20,PictureType::Result,$sorting);< /EM>

Erzeugt ein neues MultiQuery-Objekt.
Damit können mehrere MultiQuerys aufgebaut werden. D.h. mehrere Immobilientypen nach bestimmten Parametern und GeoInformationen bagefragt werden.

$multiQuery = $apiwrapper->createMultiquery();

Erzeugt ein neues Objekt von Mietwohnungsparametern.
Für jeden Immobilientyp gibt es spezielle Parameter bzw. Eigenschaften, nach denen gesucht werden kann.
Die speziellen Immobilieneigenschaften finden sie in den Query-Files (z.B. AppartmentRentQuery.php) im Ordner "service/requestService/multiQuery/".

$appartmentRentQueryParameter = new AppartmentRentQueryParameter();

Die Eigenschaft Balkon wird als "true" gesetzt, somit werden nur alle Mietwohnungen mit Balkon zurückgegeben

$appartmentRentQueryParameter->setBalcony(true);

Die Eigenschaft NetArea (Wohnfläche) wird auf zwischen 40 und 80 gesetzt, somit werden nur alle Mietwohnungen mit 40qm bis 80qm Wohnfläche zurückgegeben.

$appartmentRentQueryParameter->setNetArea(new DoubleQuery(40,80));

Die Eigenschaft NetRent (Kaltmiete) wird auf zwischen 200 und 400 gesetzt, somit werden nur alle Mietwohnungen mit einer Kaltmiete von 200Euro bis 400Euro zurückgegeben.

$appartmentRentQueryParameter->setNetRent(new CurrencyQuery(200,400));

Der Stadtteil mit uuid wird für die Multiquery al Parameter zusammengebaut, hier kann auch die uuid von z.B. einer Stadt angeben werden.

$gissuche = $apiwrapper->buildGISQueryParameter('1276003001046');

Die Anfrage wird als Multiquery hinzugefügt.
Das eben erstellte Multiquery-Objekt, der Immobilientyp und das zum Immobilientyp passende Parameter-Objekt wird übergeben.
Die Multiquery beinhaltet nun diese Abfrage: Mietwohnung mit Balkon

$apiwrapper->addMultiQuery($multiQuery, MultiQuery::AppartmentRentQuery,
  $appartmentRentQueryParameter, $gissuche);

Erzeugt ein neues Objekt von Kauf-Wohnungsparametern.
Für jeden Immobilientyp gibt es spezielle Parameter bzw. Eigenschaften, nach denen gesucht werden kann.
Die speziellen Immobilieneigenschaften finden sie in den Query-Files (z.B. AppartmentBuyQuery.php) im Ordner "service/requestService/multiQuery/".

$appartmentBuyQueryParameter = new AppartmentBuyQueryParameter();

Der Eigenschaft noRooms (Anzahl Räume) wird ein Objekt vom Typ DoubleQuery zugewiesen.
DoubleQuery ist eine Standardklasse, die Double-Werte (Kommawerte) verwaltet.
Diese Klassen zur Typenumsetzung finden sie im File "service/requestService/multiQuery/rangedTypesBaseQuery.php".
Ihr werden minimal und maximal-Werte übergeben. Hier: Mindestes 3 Zimmer und maximal 4 Zimmer.
Es werden also nur die Kauf-Wohnungen mit 3-4 Zimmern ausgegeben.

$appartmentBuyQueryParameter->setNoRooms(new DoubleQuery(3,4));

Baut eine Umkreissuche zusammen, die später an die Multiquery übergeben wird
Das Ganze erfolgt nach dem Schema (Umkreis in km, Stadt, PLZ, Straße, Hausnummer)

$umkreissuche = $apiwrapper->buildUmkreissuche('5','Berlin','10179','Magazinstraße','15');

Die Anfrage wird als Multiquery hinzugefügt.
Das eben erstellte Multiquery-Objekt, der Immobilientyp und das zum Immobilientyp passende Parameter-Objekt wird übergeben.
Die Multiquery beinhaltet nun diese Abfrage: Kauf-Wohnung mit 3-4 Zimmern

$apiwrapper->addMultiQuery($multiQuery, MultiQuery::AppartmentBuyQuery,
  $appartmentBuyQueryParameter, $umkreissuche);

Der Request wird nun zusammengebaut mit dem Resultpage-Objekt und dem MultiQuery-Objekt (dass die verschiedenen Anfragen beinhaltet)
Als Ergebnis wird ein Array mit der entsprechende Ergebnisliste zurückgeliefert.

$test = $apiwrapper->getAdvantageMultiqueryRequest($resultPage,$multiQuery);

Ruft ein Expose nach einer Scout-ID ab mit den Original-Bildern, die hochgeladen wurden und gibt das Ergebnis als Array zurück
Mögliche BilderTypen sind:
PictureType::Original
PictureType::Result
PictureType::OdW
PictureType::Large
PictureType::Expose Oringinal-Größe der Bilder, so wie sie hochgeladen wurden
Kleine Vorschaubilder (62x62px)
Objekt der Woche-Bild
Großes Bild
Bild für ein Expose

Nachzulesen im File (service/requestService/common/PictureType.php)

$test = $apiwrapper->getExpose('46130542',PictureType::Original);

oder

$test = $apiwrapper->getExposeByObjektnummer('X01.Wohnung-Miete(26)',PictureType::Original);

Erstellt eine Kontaktanfrage mit den übergebenen Parametern.
Für Informationen zu den einzelnen ContactFormParametern schauen Sie bitte in die Klasse service/contactService/ContactFormParameter.php

$contactFormParameter = new ContactFormParameter( '44407298', 'Herr', 'Max',
  'Mustermann', '030123456789', '0170123456789', 'api@immobilienscout24.de', true,
  true, 'Kommentartext', ContactMethodType::Brief(), '12:00',
  new Address('Magazinstr.', '15', '10179' , 'Berlin')) ;
$test = $apiwrapper->contactForm($contactFormParameter);

Gibt das Impressum als Array zurück

$test = $apiwrapper->getImpressum();

Gibt die Visitenkarte als Array zurück

$test = $apiwrapper->getVisitenkarte();

Ruft die MailAFriend-Funktion auf und gibt eine Erfolgsmeldung zurück
Für Informationen zu den einzelnen MailAFriendParametern schauen Sie bitte in die Klasse service/contactService/MailAFriendParameter.php

$mailAFriendParameter = new MailAFriendParameter('44407298',
  'api@immobilienscout24.de' , 'Api', 'api@immobilienscout24.de', 'Max', 'Mustermann',
  'Kommentartext');
$test = $apiwrapper->mailAFriend($mailAFriendParameter);

Die Variable $content beinhaltet ein XML-Dokument in reiner Form. Es wird nicht zusammengebaut, sondern als String übergeben.
Abfrage einer Ergebnisliste aller Mietwohnungen eines Kunden oder einer Börse.
Ergebnisliste: Seite 1 | Größe 50 Objekte | Bildtyp Result | Sortierung absteigend nach der Überschrift.

$content = '
<?xml version="1.0" encoding= "UTF-8"?>
<QueryRequest xmlns="http://www.immobilienscout24.de/api/schema/request/1.0">
  <ResultPage pageNumber="0" pageSize= "50" pictureType= "Result">
    <Sorting name= "Heading" order= "ASC"/>
  </ResultPage>
  <MultiQuery>
    <AppartmentRentQuery/>
  </MultiQuery>
</QueryRequest>';

Gibt das Result als XML-Dokument zurück.
Der entsprechende Service ist zu übergeben für die Anfrage.
Möglichkeiten:

• requestService
• contactService
• geoInfoService
• sessionService

Als 2ter Parameter wird der XML-Request als String übergeben.

$test = $apiwrapper->getXmlResult('requestService',$content);

Gibt das Result als SimpleXML-Dokument zurück.
Weiteres identisch mit der oberen Abfrage.

$test = $apiwrapper->getSimpleXmlResult('requestService',$content);

Session anpingen, damit sie erhalten bleibt.
Gibt ein Status-Array zurück.

$test = $apiwrapper->pingSession();

Eine Ergebnisliste anzeigen

$test = $apiwrapper->getAllRealEstatesByType('AppartmentRent');
foreach ($test['VendorRealEstatesResult'] as $value){
  print_r($value->Heading."<br/>");
  print_r("Preis: ".$value->price->value." ".$value->price->currency."<br/>");
  print_r("Wohnfl&auml;che: ".$value->netArea."qm"."<br/>");
  print_r("R&auml;ume: ".$value->noRooms."<br/>");
  print_r("Adresse: ".$value->street." ".$value->houseNo.
  " - ".$value->zip." ".$value->addressCity."<br/>");
  print_r("<img src=\"".$value->pictureURL."\">");
  print_r("<br/><br/>");
}

Ein Expose anzeigen

$value = $apiwrapper->getExpose('46130542',PictureType::Original);
  print_r($value->Heading."<br/>");
  print_r("Preis: ".$value->netRent->value." ".$value->netRent->currency."<br/>");
  print_r("Wohnfl&auml;che: ".$value->netArea."qm"."<br/>");
  print_r("R&auml;ume: ".$value->noRooms."<br/>");
  print_r("Adresse: ".$value->Address->street." ".$value->Address->houseNo.
    " - ".$value->Address->zip." ".$value->Address->city."<br/>");
  print_r("<img src=\"".$value->Attachments->Picture[0]->urls['Original']."\">");< /EM>
  print_r("<br/><br/>");