Interface pour le transfert d'annonces

barre de menu
Pays                     
Langue

Interface pour le transfert d'annonces

Version 2.3


1) Principe du transfert

Green-acres.com propose une interface XML permettant à des logiciels ou sites Internet sur lesquels des agences rentre leurs annonces, d'exporter ces annonces pour les publier directement sur Green-acres.com

a) Configuration Green-acres.com

Chaque agence dispose sur son interface d'administration d'un onglet 'Transfert' pour demander l'activation du système de transfert.

b) Envoi des annonces

Les annonces sont transférées avec photos en respectant le format ci-dessous. Toutes les annonces envoyées seront publiées et l'agence sera facturée en conséquence.

Sauf demande contraire, la publication des annonces se fait en mode annule et remplace : Toutes les annonces non présentes dans le flux seront automatiquement retirées de la parution.

Conformément aux conditions générales de vente de Green-acres.com, l'agence est responsable de vérifier que le résultat du transfert lui convient.

2) Tester un fichier xml

Avant toute chose, ouvrez le fichier dans un navigateur (Internet Explorer, ou Firefox qui donne plus de détails) et vérifier que le fichier est sans erreur et que tous les caractères s'affichent correctement. Puis utiliser le formulaire de validation ci-après.

Identifiant de l'agence pour ce fichier
Fichier xml

3) Format des fichiers

a) Nom des fichiers

Les annonces seront fournies sous forme d'un fichier XML respectant le format ci-dessous (voir partie 3). 2 options sont possibles pour fournir le fichier :
  • Envoi FTP : Le fichier est fournit directement par FTP (exemple '212a.xml' ou '212a-644.xml') en utilisant les codes d'accès fournis par Green-acres.com.

  • Récupération HTTP : Nous récupérons journalièrement un fichier XML correctement formaté par le biais d'une URL à nous fournir.

b) Photos

  • Envoi FTP : Les photos de l'annonce seront envoyées par FTP avec pour nom la référence Green-acres.com de l'annonce suivi du caractère '_' puis du numéro de la photo en commençant par 1. Exemple : '212a-644_1.jpg', '212a-644_2.jpg' etc. Green-acres.com accepte jusqu'à 25 photos par annonces.

    Attention ! Le numéro de référence étant en minuscule d'après la spécification ci-dessous, les noms de photos doivent aussi être en minuscule.

  • Récupération HTTP : Les photos peuvent aussi être fournies par le biais d'une URL dans le fichier XML par les balises <pic_1>,...<pic_25>, l'URL devant commencer par 'http://' et finir par '.jpg' en minuscule.
    Exemple : <pic_1>http://www.mon-site-internet.com/photo/vrw6789.jpg</pic_1>

Afin de limiter la consommation de CPU sur nos serveurs, si des photos sont déjà présentes pour une annonce, l'envoi de nouvelles photos n'entraîne pas de mise à jour des photos, sauf si l'agence a coché la case 'Forcer la mise à jour des photos (onglet 'Transfert'), avant le transfert.

b) Contenu du fichier XML

Le fichier texte décrivant une annonce contiendra tous les champs obligatoires indiqués ci-après et éventuellement les champs optionnels. Le fichier doit être au format xml comme suit :
En tête de début de fichier :

<?xml version="1.0" encoding="ISO-8859-1"?>
<Envelope>
<Body>
<add_adverts>

Pour chaque annonce :

<advert>
(...)
</advert>

Pour chaque champ de l'élément 'advert' :

<nom_champ>texte_du_champ</nom_champ>

En fin de fichier :
</add_adverts>
</Body>
</Envelope>

c) Exemple de fichier

Pour voir un exemple de fichier : Cliquez-ici

d) Zip

Les fichiers textes et photos pourront être regroupés dans un seul fichier zip qui sera alors nommé selon le nom de l'agence. Ex : '212a.zip'.

e) Encodage

L'encodage Occidental 'ISO-8859-1' est utilisé par défaut. L'encodage international 'utf-8' est aussi accepté. Dans ce cas, il est nécessaire de mettre 'utf-8' dans l'en-tête XML et d'encoder réellement le fichier en utf-8, puis de nous contacter pour que nous traitions le fichier en 'utf-8' à réception.

4) Champs obligatoires

Nom du champ Type Commentaire Exemple
owner varchar(15) Référence du compte chez Green-acres.com 212a
reference varchar(20) Référence compte et référence du produit pour l'agence. Comporte uniquement des chiffres, des lettres, '_' et '-'. Doit être en minuscule. Par défaut il est recommandé d'utiliser le numéro de mandat de l'agence comme référence produit, si le numéro de mandat détermine le produit de manière unique. 212a-644 pour le bien 644 de l'agence 212a
type enum ('properties', 'rentals', 'holidays') Type d'annonce (vente,location, location-vancances)  
price int(10) unsigned Prix frais d'agence inclus - Loyer charges incluses dans le cas d'une location 215000
currency char(3) Code monnaie international (3 lettres) EUR
postal_code varchar(5) Code postal du bien 47300
commune varchar(75) Doit contenir uniquement un nom de commune sans commentaire (pas de 'proche' ou 'A 5 mn de')
Ce champs n'a pas besoin d'être la ville exacte du bien et peut être une ville proche (Voir champs 'precise_location') 		Villeneuve sur lot
country_code char(2) Code pays du bien immobilier fr
habitat enum ('old', 'recent', 'luxury', 'land', 'appartement', 'business', 'new', 'mobile_home', 'parking', 'bed_breakfast', 'gite' ) Type de bien. La dénomanition exacte dépend du pays (en France : 'old' donne 'maison ancienne' - au Maroc : 'old' donne 'Riad') old

Si l'un des éléments obligatoires venait à manquer, l'annonce est tout de même créée et est mise en attente par défaut. L'agence peut accéder sur nos sites aux annonces en attente et compléter rapidement les éléments manquants. Si seul l'environnement et/ou l'habitat venait à manquer, ces éléments sont devinés à partir du résumé textuel (attention le taux d'erreur est élevé) et le champs optionnel 'status' peut être forcé à 'ok' (voir ci-dessous).

5) Champs facultatifs

Nom du champ Type Commentaire Exemple
mandate_number varchar 16 Numéro de mandat. Si le numéro passé en référence est un numéro informatique, vous pouvez utiliser ici le numéro de mandat ou tout numéro utile à l'agence pour retrouver un bien rapidement. Wd-5913
title_XX varchar 60 Titre de l'annonce dans la langue XX où il faut remplacer XX par le code langue (title_fr). Il est possible d'insérer un élément title_XX pour chaque langue active pour le site. Limité à 60 caractères.
Les traductions automatiques sont interdites dans cette section. 		Charmante propriété sur 5 ha de terrain
summary_XX blob Texte de présentation général du bien dans la langue XX où il faut remplacer XX par le code langue (summary_fr). Il est possible d'insérer un élément summary_XX pour chaque langue active pour le site.
Les traductions automatiques sont interdites dans cette section. 		Située dans le village de Laz, avec bar et commerce à une courte distance à pied, cette maison qui nécessite de travaux de rénovation bénéficie d'une vue étonnante sur la vallée de l'Aulne et au-delà.
h_surface int Surface habitable en m2 250
l_surface int Surface terrain en m2 20000
n_rooms int Nombre de pièces 6
n_beds int Nombre de chambres 3
n_baths int Nombre de salles de bains 2
environment enum ('country', 'village', 'town', 'city', 'beach', 'mountain') Environnement dominant de la propriété country
precise_location int Localisation par rapport au code postal indiqué :
0 = A proximité de (valeur par défaut
1 = Localisation précise 		0
street_number varchar(12) Numéro de rue 17 bis
street_name varchar(64) Nom de la rue Avenue Aristide Briand
metro varchar(32) Nom du métro le plus proche Porte d'Orléan
distance_metro int Distance exprimé en minute du métro le plus proche 5
airport varchar(32) Nom de l'aéroport le plus proche Bergerac
distance_airport int Distance exprimé en minute de l'aéroport le plus proche 5
train varchar(32) Nom de la gare la plus proche Bergerac
distance_train int Distance exprimé en minute de la gare la plus proche 5
charges int Charges pour le loyer 150
furnished enum(0,1) Non meublé / Meublé pour une location (Défaut : 0 non meublé) 0


6) Afficher le fichier de spécifications xsd

Cliquez ici

7) Mentions légales

Green-acres.com décline toute responsabilité sur les problèmes et éventuelles pertes de données liées à l'usage du logiciel ou du site Internet de l'éditeur proposant une passerelle vers ses sites.

L'agence est responsable de vérifier que le résultat du transfert correspond à son attente et d'effectuer les éventuelles modifications nécessaires directement sur Green-acres.com