1. Introductie
Max-Immo External Parties API (verder MIEP genaamd) is de technisch uniforme en transparante wijze waarop Max-Immo de data-uitwisseling tussen haar klanten en derde partijen faciliteert. Om een vlotte samenwerking te garanderen staat de werking van het systeem in deze handleiding beschreven.
Alle benodigde documentatie om MIEP correct te implementeren, kan u onder de sectie API documentatie terugvinden.
2. Authenticatie
Voor de beveiligde gebruikersverificatie, autorisatie en toegangscontrole maakt MIEP gebruik van het OAuth 2.0 protocol. Dit betekent dat u een access token zal nodig hebben om toegang te krijgen tot de data van uw klanten. Dit token verkrijgt u door uw client credentials in de vorm van een client_id en een client_secret in te voeren. Deze credentials hebt u van onze via e-mail ontvangen.
OAuth access tokens hebben slechts een beperkte geldigheidsduur. Wij adviseren u dan ook om er voor te zorgen dat u automatisch nieuwe access tokens genereert van zodra deze vervallen. Daarmee vermijdt u dat u uw client credentials steeds opnieuw handmatig moet invoeren. Voor wie in PHP ontwikkelt, hebben wij reeds een API client library ter beschikking die onder andere deze functie bevat.
3. Datacollectie
Het ophalen van de gegevens gebeurt op een gestandaardiseerde wijze die stap voor stap beschreven staat in de API documentatie.
Wanneer u uw OAuth access token meestuurt, hebt u toegang tot de gegevens van alle Max-Immo klanten die naar u wensen door te sturen via MIEP. Momenteel kan u deze gegevens ophalen aan een frequentie van maximaal 24 API calls per dag. Eens de dagelijkse limiet is overschreden, zal u geen nieuwe updates meer ontvangen. Bij elke extra opvraging zal u enkel de laatst bewaarde wijzigingen terugkrijgen.
Om een verbinding tot stand te brengen tussen u en een makelaar, dienen wij de doorstuur manueel te activeren in de Max-Immo software van deze klant. Gelieve de makelaars waarmee u gaat koppelen te adviseren om hiervoor contact op te nemen met onze Helpdesk. De contactgegevens vindt u onderaan. In een later stadium zullen deze koppelingen volledig geautomatiseerd verlopen en komt deze manuele tussenstap te vervallen.
4. Contact
Voor vragen, opmerkingen en technische ondersteuning kan u terecht bij onze helpdesk via onderstaande gegevens:
Telefoon: +32 (0)16 46 89 97
E-mail: [email protected]