Aller au contenu principal

Spécifications du flux entrant

Transpareo accepte un flux d'annonces locatives longue durée au format ImmoFacile XML 3.0 : le même format que le produit génère en sortie. Un professionnel ou un réseau de multidiffusion peut tester son fichier avant tout raccordement.

Comment se brancher

Une agence peut passer par Ubiflow, par un export Poliris, par le logiciel qui produit déjà son fichier, ou par la saisie manuelle. Le validateur public accepte aujourd'hui ImmoFacile XML 3.0, le CSV et le JSON Lines. Un flux de réseau, un fichier pour plusieurs établissements, rattaché par le code agence, sera précisé au moment du branchement.

Formats acceptés

  • immofacile_xml : ImmoFacile 3.0 (+ alias éditeurs : TYPEBIEN, CODEPOSTAL…)
  • agency_csv : CSV séparateur ;, en-têtes FR
  • jsonl / institutional_jsonl : JSON Lines (passerelles custom / offres institutionnelles)

Champs ImmoFacile

Obligatoires pour qu'une ANNONCE soit acceptée : REFERENCE, localisation (VILLE / CODE_POSTAL), type de transaction et de bien, loyer. Fortement recommandés : surface, pièces, DPE, étage. Périmètre Transpareo : location longue durée uniquement (pas de vente / saisonnier dans le catalogue cible).

<IMMOFACILE version="3.0">
  <AGENCE>…</AGENCE>
  <ANNONCE>
    <REFERENCE>…</REFERENCE>
    <TYPE_TRANSACTION>LOCATION</TYPE_TRANSACTION>
    <TYPE_BIEN>APPARTEMENT</TYPE_BIEN>
    <LOCALISATION>…</LOCALISATION>
    <CARACTERISTIQUES>…</CARACTERISTIQUES>
    <PRIX>…</PRIX>
    <DPE>…</DPE>
  </ANNONCE>
</IMMOFACILE>

Règles de validation

  • XML mal formé ou sans balise ANNONCE → refus avec message exploitable.
  • Annonce sans REFERENCE → erreur ligne à ligne ; les autres annonces du même fichier peuvent passer.
  • Le validateur public n'écrit rien dans le catalogue : parse structurel uniquement.
  • Contrepartie à la diffusion : DPE renseigné si obligatoire, adresse réelle, mentions légales : vérifiées à l'inscription du flux (dépôt libre-service).

Cadence

Cible : reprise horaire ou push après raccordement. Pendant la phase de test, utilisez le validateur ci-dessous ; le dépôt périodique en libre-service suit ces spécifications.

Fichier d'exemple

Télécharger exemple-immofacile.xml

Validateur

POST /api/v1/flux/validate : corps = fichier brut, ou JSON { "feed": "…" }. Réponse 200 si structure OK, 422 si erreurs (messages par ligne).

# Valide
curl -sS -X POST --data-binary @exemple-immofacile.xml \
  "https://transpareo.fr/api/v1/flux/validate"

# Invalide (attendu : 422 + message)
curl -sS -X POST --data-binary '<IMMOFACILE></IMMOFACILE>' \
  "https://transpareo.fr/api/v1/flux/validate"

Raccordement

  1. Validez votre fichier avec le validateur ci-dessus.
  2. Déposez l'URL de votre flux en libre-service : /specs/flux/depot (validation de contrepartie + première reprise + reprise horaire).
  3. Ou contactez-nous via le formulaire de contact pour un raccordement multidiffusion.

Données ouvertes · Contact · Import assisté particuliers