↔️API
Ce type de connexion nous permet d'indiquer en temps réel le nombre de logements disponibles dans chaque résidence. À chaque mise à jour de vos données — qu’il s’agisse d’un ajout de logement, d’un changement de caractéristiques (surface, nombre de logements, loyer, équipements…) — l’information est automatiquement synchronisée sur la plateforme MLE, sans intervention manuelle.
⚙️ Les avantages pour vous
En choisissant un partage automatisé, vous bénéficiez de plusieurs atouts concrets :
Gagner du temps : plus besoin de nous transmettre un fichier Ă chaque modification.
Réduire les erreurs : les données sont directement extraites de votre source, ce qui évite les oublis ou les doublons.
Assurer une information fiable : les étudiants accèdent à des annonces à jour.
🔧 Comment ça fonctionne concrètement ?
Une API authentifiée est fournie par une méthode au choix (pas d’authentification (non recommandé), API Key, token, oauth, basic auth, …).
Le format de sortie de l’API est JSON, un seul point de terminaison GET nécessaire, de type liste.
Les images fournies seront téléchargées et stockées côté MLE afin de pouvoir servir les images même si la plateforme bailleur connaît des difficultés d’accès.
Exemple :
[
{
"name": "RĂ©sidence CROUS",
"address": "123 Rue de l'Étudiant",
"city": "Palaiseau",
"postal_code": "91120",
"residence_type": "u-crous",
"latitude": 48.7137,
"longitude": 2.2414,
"owner_name": "CROUS de Versailles",
"owner_url": "https://www.crous-versailles.fr",
"nb_total_apartments": 96,
"nb_accessible_apartments": 3,
"nb_coliving_apartments": 10,
"nb_t1": 70,
"t1_rent_min": 400.0,
"t1_rent_max": 500.0,
"nb_t1_bis": 3,
"t1_bis_rent_min": 450.0,
"t1_bis_rent_max": 550.0,
"nb_t2": 20,
"t2_rent_min": 600.0,
"t2_rent_max": 700.0,
"nb_t3": 7,
"t3_rent_min": 800.0,
"t3_rent_max": 900.0,
"nb_t4_more": 0,
"t4_more_rent_min": null,
"t4_more_rent_max": null,
"pictures": [
"https://example.com/picture1.jpg",
"https://example.com/picture2.jpg"
],
"laundry_room": true,
"common_areas": true,
"bike_storage": true,
"parking": true,
"secure_access": true,
"residence_manager": true,
"kitchen_type": "shared",
"desk": true,
"cooking_plates": true,
"microwave": true,
"refrigerator": true,
"bathroom_shared_or_private": false
},
{
"name": "Résidence Étudiante Alpha",
"address": "456 Avenue des Universités",
"city": "Lyon",
"postal_code": "69007",
"residence_type": "u-prive",
"latitude": 45.7485,
"longitude": 4.8467,
"owner_name": "Alpha RĂ©sidences",
"owner_url": "https://www.alpha-residences.fr",
"nb_total_apartments": 120,
"nb_accessible_apartments": 5,
"nb_coliving_apartments": 15,
"nb_t1": 80,
"t1_rent_min": 450.0,
"t1_rent_max": 550.0,
"nb_t1_bis": 5,
"t1_bis_rent_min": 500.0,
"t1_bis_rent_max": 600.0,
"nb_t2": 25,
"t2_rent_min": 650.0,
"t2_rent_max": 750.0,
"nb_t3": 8,
"t3_rent_min": 850.0,
"t3_rent_max": 950.0,
"nb_t4_more": 2,
"t4_more_rent_min": 1000.0,
"t4_more_rent_max": 1200.0,
"pictures": [
"https://example.com/picture3.jpg",
"https://example.com/picture4.jpg",
"https://example.com/picture5.jpg"
],
"laundry_room": true,
"common_areas": false,
"bike_storage": true,
"parking": false,
"secure_access": true,
"residence_manager": false,
"kitchen_type": "private",
"desk": false,
"cooking_plates": true,
"microwave": false,
"refrigerator": true,
"bathroom_shared_or_private": true
},
...
]Note 1 : les champs peuvent être renommés, MLE fera un mapping si nécessaire.
Note 2 : il peut y avoir des champs additionnels cela ne cassera pas l’intégration.
Note 3 : les images peuvent être fournies en base64 s’il n y a pas de moyen existant pour les servir via http/https.
MLE s’engage à interroger l’API de manière périodique (fréquence à définir entre MLE et le bailleur selon fréquence de mise à jour des informations côté bailleur) en utilisant une fréquence de requêtes non élevée afin de préserver la disponibilité de la plateforme du bailleur. (exemple : 10 requêtes / minutes)
Last updated