Guide d'intégration pour les agences partenaires
Ce document décrit le format attendu pour le flux d'annonces immobilières que votre agence peut diffuser sur VIP By HDI. Il vous permet d'automatiser la publication de vos biens sur notre plateforme sans saisie manuelle.
Cette section explique comment démarrer la diffusion de vos annonces sur la plateforme. Le détail technique des champs XML figure dans les sections suivantes.
Contrairement à d'autres plateformes qui demandent à votre logiciel de « pousser » un fichier vers un endpoint FTP ou une API, VIP By HDI fonctionne en mode « pull » : c'est notre serveur qui vient lire votre flux à intervalles réguliers (toutes les 6 heures). Vous n'avez rien à installer, rien à configurer côté serveur, et aucune URL de destination à renseigner.Il suffit de nous transmettre l'URL d'export de votre logiciel métier — nous faisons le reste.
Vous êtes une agence seule, non rattachée à un réseau
Exportée depuis votre logiciel métier (Hektor, Apimo, Netty, Logic-Immo…)
Poliris, Apimo, Ubiflow ou autre — détection automatique si vous ne savez pas
Idéalement une URL publique sans mot de passe. Si elle est protégée, communiquez-nous les identifiants
Chaque annonce doit avoir une référence stable pour que les mises à jour et suppressions fonctionnent
Vous dirigez un réseau avec des agences ou mandataires affiliés
Le flux central du réseau
Un flux par mandataire ou agence affiliée
C'est lui qui permet de regrouper tous les sous-flux ensemble dans l'administration
Vous ajoutez un agent commercial rattaché à votre réseau ou agence
Renseignez les coordonnées fournies par le directeur de réseau ou d'agence (voir le formulaire ci-dessous)
Le compte est créé déjà validé. Un email d'invitation est envoyé à l'agent pour qu'il définisse son mot de passe
Si l'agent a un flux XML différent du responsable, fournissez-le. Sinon, ne pas redonner le même flux que le responsable pour éviter les annonces en doublon
En une phrase, pour l'agence :
« Pouvez-vous me transmettre l'URL de votre flux d'export XML d'annonces (depuis votre logiciel métier), accessible sans mot de passe, avec une référence unique par bien ? »
Ces informations servent à générer automatiquement la convention de diffusion du sous-compte.
* champs obligatoires
Convention de diffusion : elle est considérée comme lue et acceptée dès la première diffusion d'une annonce et vaut accord de diffusion.
Notre système d'import reconnaît automatiquement la structure de votre flux XML. Aucune transformation n'est nécessaire de votre côté : exportez le flux tel quel depuis votre logiciel métier.
<annonce>Format utilisé par Hektor, Netty, Immobilier.fr, Logic-Immo…
<property>Format du logiciel Apimo (agences indépendantes)
<ad>Format Ubiflow (diffuseur multi-portails)
<item>Tout autre format XML structuré (analyse automatique)
Le parser reconnaît de multiples noms de balises pour chaque champ (synonymes français/anglais). Le tableau ci-dessous liste les principaux. Si votre flux utilise d'autres noms, le système tente une détection automatique — sinon contactez-nous pour un mapping personnalisé.
| Champ | Balises XML reconnues | Oblig. | Note |
|---|---|---|---|
| Référence | ref, reference, id | ● | Identifiant unique de l'annonce (upsert) |
| Titre | titre, title, name | ● | Titre affiché dans l'annonce |
| Type de bien | type, bien_type, categorie | ○ | Appartement, maison, terrain… |
| Prix (€) | prix, price, montant | ● | Prix TTC en euros |
| Surface (m²) | surface, superficie, area | ○ | Surface habitable |
| Nb pièces | nb_pieces, rooms, pieces | ○ | Nombre de pièces |
| Nb chambres | nb_chambres, bedrooms | ○ | Nombre de chambres |
| Ville | ville, city, commune | ● | Commune du bien |
| Code postal | code_postal, cp, zip | ● | Code postal (département auto-déduit) |
| Description | description, texte, descriptif | ○ | Texte de l'annonce (max 1000 car.) |
| Photos | photos, images, gallery | ○ | URLs complètes (https://…), max 10 |
| DPE | dpe_lettre, classe_energie | ○ | Étiquette énergie A à G |
| Email contact | email, contact_email | ○ | Pour les sous-comptes mandataires |
| Téléphone | telephone, tel, phone | ○ | Téléphone de contact |
Référence unique : chaque annonce doit avoir une référence stable. C'est elle qui permet de détecter les annonces modifiées (mise à jour) ou retirées (suppression automatique de la plateforme).
Si votre structure est un réseau (franchise, groupement) avec des mandataires ou agences indépendantes, chaque sous-compte peut avoir son propre flux XML. Le système regroupe automatiquement les flux partageant le même email de compte principal.
L'administrateur de la plateforme peut synchroniser tous les flux d'un réseau d'un seul clic.
Procédure d'intégration :
Contact : didier.herve8@gmail.com · 0679219676