API - Schnittstelle Interessentenformular (D)

Geändert am Do, 12 Jun um 10:45 VORMITTAGS

MELON bietet die Möglichkeit ihr Formular via POST Request und JSON per API anzubinden, damit die Interessenten direkt in melon aufgelistet werden und alle Informationen an einem Platz sind. Im Gegensatz zum kostenpflichtigen Kontaktformular iFrame hat man dadurch mehr Freiheit bezüglich Design.

Verfügbare Merkmale

Key	Label	Werte
min_max_miete_0	Minimalwert Bruttomiete	Ganzzahl
min_max_miete_1	Maximalwert Bruttomiete	Ganzzahl
min_max_area_0	Minimalwert Fläche	Ganzzahl
min_max_area_1	Maximalwert Fläche	Ganzzahl
min_max_rooms_0	Minimalwert Zimmer	Dezimalzahl
min_max_rooms_1	Maximalwert Zimmer	Dezimalzahl
rooms	Anzahl Zimmer	Dezimalzahl
object_type	Objekttyp	apartment, craft, parkingspace, house, plot, others
object_title	Objektbezeichnung	Text
object_reference_number	Referenznummer	Text
household_type	Haushaltstyp	single_person_household, couple_household, couple_household_with_child, single_parent_household, flat_share, other_household
title	Anrede	male, female, other_gender
firstname	Vorname	Text
name	Nachname	Text
street_nr	Strasse und Nummer	Text
postcode	PLZ	Ganzzahl
city	Ort	Text
phone	Telefonnummer	Text
email	Email-Adresse	Emailadresse
date_of_birth	Geburtsdatum	Datum (JJJJ-MM-TT)
remarks	Bemerkung / Nachricht	Text
additional_info	Zusätzliche Informationen	Text
howfound	Quelle	real_estate_platform, project_website, facebook, instagram, construction_site_panel, relationship_network, advertising_posters, print_ads, online_ads, radio_ads, newsletter, public_transport_ads, open_house_day, search_engine, flyer, other_source

Zusätzliche Information:

Die Referenznummer ist ein eindeutiger Identifikator. Beim Erstellen von Objekten muss daher sichergestellt werden, dass alle Objekte mit einer Referenznummer jeweils eine eindeutige Nummer haben.
Die Logik, nach der die API entscheidet, welchem Objekt ein Interessent zugewiesen wird, ist wie folgt:

Wenn die Anfrage nur den object_title enthält, wird dieser verwendet (aktuelle Logik).
Wenn die Anfrage nur die object_reference_number enthält, wird diese verwendet (neue Logik).
Wenn beides enthalten ist, hat die object_reference_number Vorrang und wird verwendet.

API URL und Zugangsdaten

Die Schnittstelle kann unter der URL angesprochen werden:
melon.market: IHRPROJEKT.api.melon.market/external-data-hook
melon.rent: IHRPROJEKT.api.melon.rent/external-data-hook
melon.sale: IHRPROJEKT.api.melon.sale/external-data-hook

Für die Anbindung der Schnittstelle sind Zugangsdaten notwendig:
Benutzer: immoserver
Passwort: LWJ7fWHYxHb4cCMQq76w

JSON Format

{"rooms": "3.5",
 "object_type": "apartment",
 "min_max_miete_0": "500",
 "min_max_miete_1": "1500",
 "title": "Herr",
 "firstname": "MELON",
 "name": "Support",
 "street_nr": "Kanzleistr 126",
 "postcode": "8004",
 "city": "Zürich",
 "phone": "0435434416",
 "email": "support@emonitor.ch",
 "remarks": "Bemerkung",
 "object_title": "A01",
 "object_reference_number": "001"
}

PHP Beispiel

$data = array(
    'rooms' => $rooms,
    'object_type' => $object_type,
    'household_type' => $household_type,
    'min_max_miete_0' => $min_max_miete_0,
    'min_max_miete_1' => $min_max_miete_1,
    'title' => $title,
    'firstname' => $firstname,
    'name' => $name,
    'street_nr' => $street_nr,
    'postcode' => $postcode,
    'city' => $city,
    'phone' => $phone,
    'email' => $email,
    'remarks' => $remarks,
    'object_title' => $object_title,
    'object_reference_number' => $object_reference_number
);


$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://IHRPROJEKT.api.melon.rent/external-data-hook");
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_USERPWD, 'immoserver:LWJ7fWHYxHb4cCMQq76w');
$response = curl_exec($ch);
curl_close($ch);