Objektliste

Achtung, diese API ist eine Frontend API und unterscheidet sich in der Implementierung von den Content-APIs.

Ziel dieser API ist es eine Liste von Objekten mit rudimentären Eigenschaften abzufragen die dann für eine verkürzte Darstellung als z.B. Widgets auf der Startseite der eigenen Webseite verwendet werden können.

Was diese API nicht ist: Diese API stellt keine Buchungssystem Schnittstelle bereit oder soll einen vollständigen Objektumfang abbilden, sie ist nicht für professionelle Vertriebskanäle gedacht. Bitte erkundigen Sie sich bei unserem Support nach der entsprechenden API für diesen Einsatzzweck.

Endpoint

URL: https://www.optimale-praesentation.de/api/object/1/getobjectshortdatalist?secratoid=YOUR_ID_HERE

Pflichtangaben

Es muss mindestens die secratoid und der API Key als Header angegeben werden. Beide Werte sind über unseren Support erhältlich. Während die secratoid als GET Wert an die URL gehängt wird, muss der API Key in einem Custom Header mit dem Request gesendet werden: X-OP-APIKEY.

Filterung

Hinweis: Die Verwendung von Filtern ist vollständig optional.

Es werden Limit Angaben gemäß der Frontend Widget Limit Angaben im GET Body unterstützt. Die Filter sind dafür JSON encodiert als GET Body zu senden.

Caching

Alle Requests an diese API werden, soweit möglich, aus dem Cache beantwortet und sind daher nicht als Live-Stand zu verstehen. Die Cachedauer beträgt dabei regelmäßig einige Stunden. Unabhängig davon wird von Ihnen bei der Nutzung dieser API ein eigenes Cachingsystem erwartet, um den Traffic grundsätzlich so gering wie möglich zu halten. Keinesfalls sollten Sie Ihren Frontendtraffic 1:1 weiterleiten.

Beispiele

PHP

<?php
$url = "https://www.optimale-praesentation.de/api/object/1/getobjectshortdatalist?secratoid=YOUR_ID_HERE";

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER,1);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_TIMEOUT,60);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    "X-OP-APIKEY: YOUR_API_KEY_HERE"
));
$output = curl_exec($ch);
curl_close($ch);

echo $output;

exit;

Response

Die Antworten der API sind, bis auf elementare Authentifizierungsprobleme, im JSON Format.

Der eigentliche Content der Response ist dabei in response['data']['results'] zu finden.

results ist dabei eine Liste der entsprechend gefundenen Objekte wobei ObjMetaNr als Key zur leichteren Auffindbarkeit verwendet wird.

Jedes Ergebnis ist dabei wie folgt aufgebaut

• ObjMetaNr, int, Objektnummer
• propertyname, string, Objektname
• stars, object, Klassifizierungsinformationen
• stars.count, float, Sterneanzahl (inkl. 0,5-er Wertungen)
• stars.type_code, string, Typ der Klassifizierung (DTV, DEHOGA, etc.)
• restrictions, object, Beschränkungen des Objektes (bspw. Personenanzahl)
• restrictions.max_adults, int, maximale Anzahl an Erwachsenen
• restrictions.max_persons, int, maximale Anzahl an Personen
• area, object, Flächenangaben der Objektes in m²
• area.min, float, kleinste bekannte Fläche einer Untereinheit (ansonsten identisch mit max Wert wenn nur eine Einheit)
• area.max, float, größte bekannte Fläche einer Untereinheit (ansonsten identisch mit min Wert wenn nur eine Einheit)
• objecttype_code, string, Objekttyp Code (mögliche Werte)
• buildinglevel, string, Lage/Etage
• address, object, Adressangaben
• address.street, string, Straße
• address.number, string, Hausnummer
• address.zip, string, Postleitzahl
• address.city, string, Ort
• address.country, string, Land
• address.county_code, int, Landescode
• address.city_code, int, Ortscode
• geoposition, object, Geoposition
• geoposition.lat, float, Geoposition (lat)
• geoposition.lon, float, Geoposition (lon)
• rooms, object, Rauminformationen
• rooms.bedrooms, int, Schlafzimmeranzahl
• images, array, Bilder (Hinweis: Wenn eine Auflösung nicht vorhanden ist, wird die jeweils größte vorhandene ausgegeben)
• images[].desktop, string, Bild URL (max 1200px)
• images[].tablet, string, Bild URL (max 640px)
• images[].phone, string, Bild URL (max 480px)
• properties, object, Ausstattungsmerkmale (nur vorhandene), Key des Objects ist der Merkmalcode
• properties[], string, Ausstattungsmerkmalname (vorhanden)
• addons, array, mögliche Serviceleistungen
• addons[], string, Serviceleistungen

Sollte kein Ergebnis gefunden werden, ist results ein leeres Array.