Détails de la spécification XML utilisée dans Kyero.com pour importer les détails des propriétés depuis d'autres systèmes Kyero.com.
Cette page présente les spécifications d'un fournisseur de données XML pour l'envoi d'informations à Kyero.com. (Version anglaise)Dernière modification le 18 août 2020 - V3.6
Contenu
- Pour commencer
- Synopsis
- Directives et conventions
- Aperçu de la structure de fourniture des données
- A propos de la programmation des caractères
- Test de la structure
- Test de la programmation des caractères
- Soumettre un flux de données pour validation
- Automatisation des mises à jour des propriétés
- Obtenir de l'aide
- Informations sur la version
1. Pour commencer
- Voir ces notes détaillées, cet exemple de provisionnement de données et de définition de schéma XML (XSD)
- Créez votre fournisseur de données (sections 2 - 5)
- Testez-le (sections 6 et 7)
- Soumettez-le à Kyero.com pour validation finale (section 8)
2. Synopsis
Votre flux de données XML contient toutes les informations pour un compte d'annonceur Kyero.com. Nous faisons correspondre l'URL du fournisseur de données que vous nous avez donnée à un compte d'annonceur dès que nous validons et approuvons le fournisseur de données.
Chaque URL de fournisseur de données peut contenir uniquement des informations sur les biens pour un compte Kyero ou un agent immobilier. Si vous créez des fournisseurs de données pour plusieurs agents immobiliers, chacun d'entre eux doit être disponible à une seule URL.
Si vous souhaitez protéger un fournisseur de données par un mot de passe afin qu'il ne soit pas accessible au public, vous devez simplement fournir l'URL du fournisseur de données dans l'un des formats suivants.
- http://usuario:contrasena@paginaweb.com
Nous ne pouvons pas accepter une URL d'un fournisseur de données qui nécessite une intervention manuelle (comme cliquer sur un bouton pour confirmer), car le processus de notre fournisseur de données immobilières est entièrement automatique.
Votre fournisseur de données immobilières doit être un fournisseur de données absolues de toutes les informations immobilières et non un fournisseur incrémentiel. Chaque fois que nous traitons un fournisseur de données, nous l'évaluons avec tous les autres biens de ce compte dans la base de données Kyero. Votre fournisseur de données doit contenir TOUTES les propriétés que vous souhaitez AJOUTER ou METTRE À JOUR. Il ne doit pas contenir de propriétés que vous voulez SUPPRIMER.
Lorsqu'un bien est AJOUTÉ à votre base de données, il y aura un nouvel enregistrement de bien pour lui dans votre fournisseur de données. Il sera INSÉRÉ dans notre base de données et nous traiterons et stockerons toutes les images liées.
Si une propriété est MISE À JOUR dans votre base de données, la balise <date> de votre fournisseur de données sera modifiée. Lorsque nous voyons un changement dans la balise <date>, la propriété est MISE À JOUR dans notre base de données et nous traitons toutes les images liées.
Si un bien est SUPPRIMÉ de votre base de données, aucun enregistrement de ce bien ne restera dans votre fournisseur de données. Nous SUPPRIMONS les propriétés et toutes les images associées de notre base de données lorsqu'il n'y a aucune preuve qu'une propriété correspond à votre fournisseur de données.
Pour insérer, mettre à jour ou supprimer correctement, nous devons systématiquement identifier chaque propriété comme une entité unique dans votre fournisseur de données. Pour ce faire, nous utilisons la balise <id> qui doit identifier de manière cohérente et unique chacune de vos propriétés.
3. Directives et conventions
Vous devez coder votre fournisseur de données pour fragmenter les nouvelles balises en nouvelles lignes (notre analyseur syntaxique ne peut traiter qu'une seule limite de caractères de ligne) - de plus, il nous est beaucoup plus facile de lire et de dépanner votre fournisseur de données. Utilisez-le dans le document qui crée votre sortie XML. Lorsque vous examinez la sortie XML dans un éditeur de texte - vous devriez voir chaque balise sur une nouvelle ligne.
Pour forcer les sauts de ligne dans les textes des descriptions de propriétés, vous pouvez utiliser l'entité UTF-8 
 ; numeric.
Dans les notes détaillées, nous vous indiquerons quelles balises utiliser, ce qu'elles peuvent contenir et si une balise est obligatoire ou facultative.
- Les balises XML ressemblent à ceci : <beds>4</beds>
- Les commentaires ressemblent à ceci : // optional numeric
Une balise peut être "facultative" ou "obligatoire" et peut contenir des caractères "alpha", "alphanumériques" ou "numériques". La balise <date> est la seule exception où elle doit être formatée comme datetime YYYYY-MM-DD HH:MM:SS
Si une balise est autorisée à être vide (balises facultatives) - elle peut être encodée de quatre manières différentes :
- <beds></beds>
- <beds>0</beds> (donde se permiten los valores numéricos)
- <beds />
- (non balisé)
Toutes les balises sont sensibles à la casse et DOIVENT toujours être écrites en minuscules : <DESC> n'est PAS la même chose que <desc>.
N'incluez pas d'URL "pas d'image" ou "image à venir" pour les propriétés qui n'ont pas d'images.
N'utilisez pas les balises [[CDATA]] dans votre fournisseur de données comme une "solution rapide" aux problèmes de programmation de caractères.
4. Aperçu de la structure de fourniture des données
La structure d'une propriété proprement dite se trouve dans la partie droite de la marge de cette page. Votre fournisseur de données contiendra plusieurs propriétés en répétant la structure ci-jointe avec <property></property> pour chacune.
Lorsque vous construisez le fournisseur de données, consultez les notes détaillées et l'exemple de fournisseur de données XML.
5. A propos de la programmation des caractères
Il y a cinq caractères qui doivent être programmés si vous voulez les utiliser dans votre fournisseur de données. En effet, ils disposent de fonctions prédéfinies en XML (vous pouvez également utiliser leurs entités numériques).
- < - Symbole inférieur à (<) - <
- > - Le symbole plus grand que (>) - >
- & - L'esperluette (&) - &
- ' - Le guillemet ou l'apostrophe (') - '
- " - Les deux guillemets (") - "
- - Pour forcer les sauts de ligne dans les descriptions.
Quand faut-il les programmer et quand faut-il les laisser tels quels ?
Par exemple : <image id="9"> - les guillemets ne sont pas programmés car ils délimitent un attribut XML au sein d'une balise XML.
<desc>Une "belle" maison</desc> - les guillemets sont programmés car ils font partie d'une chaîne de texte.
<property> ne doit pas être programmé comme <property> ; ou <property>.
Le texte bed & breakfast doit être programmé comme bed & breakfast ou bed & breakfast - dans le premier exemple en utilisant une entité XML et, dans le second, une entité numérique.
Dans cet exemple, l'entité XML & est identique à son équivalent HTML. Cependant, en général, les entités HTML ne doivent pas être utilisées dans votre fournisseur de données. Il ne doit pas y avoir d'entités, de balises ou de formats HTML dans un fournisseur de données.
Avant de soumettre un fournisseur de données à Kyero.com, testez-le en utilisant ce validateur de caractères, en sélectionnant UTF-8 comme schéma de programmation.
Vous êtes confus au sujet de la programmation des caractères ? - Joel on Software a un article très intéressant sur le sujet (en anglais).
6. Test de la structure
Dès que vous avez un fournisseur de données prêt à être traité, testez-le d'abord en l'ouvrant dans un navigateur Mozilla (Firefox, pas Internet Explorer).
Si Firefox l'affiche avec succès, il ne contient pas d'erreurs structurelles XML fondamentales. Sinon, Firefox vous donnera le numéro de ligne du fournisseur de données qui contient la première erreur. Firefox exposera également les problèmes de base de la programmation des caractères.
Une fois que vous avez vu le fournisseur de données dans Firefox, visitez le validateur XML. Vous pouvez l'essayer avec cet exemple de flux
Une fois que vous avez un fichier XML structurellement normal, vous êtes prêt à tester la programmation des caractères.
7. Test de la programmation des caractères
Visitez ce validateur de caractères W3.org pour valider votre fournisseur de données URL.
Sélectionnez le type de programmation comme : UTF-8 (Unicode, worldwide), cliquez sur Validate.
Malheureusement, même si le fournisseur de données est programmé correctement, vous recevrez toujours des erreurs. En haut de la page de résultats, le fournisseur de données correctement validé sera affiché :
Result: Failed validation, 1 error (Resultado: Validación ha fallado, 1 error)
Faites défiler jusqu'au bas de la page des résultats, sous la bannière :
This page is not Valid XML! (Esta página no es XML válida!) verás el siguiente error:Error Line 2 column 1: no document type declaration (Error línea 2 columna 1: declaración no este tipo de documento.)
Cela peut être ignoré sans problème. Vous pouvez également ignorer les trois avertissements :
- Missing "charset" attribute for "text/xml" document (Attribut "charset" manquant pour un document "text/xml".)
- Character Encoding Override in effect! (L'annulation manuelle de la programmation des caractères fonctionne !)
- No DOCTYPE found! Attempting validation with XHTML 1.0 Transitional (DOCTYPE non trouvé ! Tentative de validation avec XHTML 1.0 en transition)
(Vous pouvez vérifier ces erreurs acceptables en utilisant cet exemple de flux).
Toutes les erreurs doivent être examinées et résolues avant de soumettre un flux à Kyero.
8. Soumettre un flux de données pour validation
Dès que vous avez un fournisseur de données qui passe la validation de la programmation et du schéma XML, ouvrez un nouveau ticket de support avec l'URL de votre flux (n'oubliez pas de nous dire pour quel compte d'annonceur Kyero.com le fournisseur de données est destiné).
Nous validerons le fournisseur de données dans un système de développement et vous ferons part de nos réactions, généralement le même jour ouvrable.
Veuillez ne pas soumettre un ticket pour un fournisseur de données qui présente des erreurs de programmation structurelles ou de caractères. Nous reviendrons ici sur ce document et sur les spécifications et tests détaillés.
9. Automatisation des mises à jour des propriétés
Dès que nous aurons testé avec succès votre fournisseur de données, nous le traiterons manuellement dans le système live de Kyero.com et vous informerons du moment où les propriétés pourront être examinées.
Lorsque les propriétés seront en ligne, nous traiterons votre fournisseur de données tous les jours à environ 01:30 CET.
Les fournisseurs de données qui ne sont pas conformes à nos spécifications ou qui présentent un comportement défavorable peuvent être mis à jour une fois par semaine ou arrêtés.
Il est important de se rappeler que vous devez TOUJOURS utiliser votre système de gestion de propriétés d'origine pour gérer vos propriétés, et NON votre compte Kyero.com. Lorsque nous traitons votre fournisseur de données, nous REMPLACONS les informations qui se trouvent dans votre compte Kyero.com.
Cela signifie que si vous modifiez les détails de votre propriété en utilisant votre compte Kyero.com, ces modifications seront perdues lors du prochain traitement de votre fournisseur de données. Cependant, les propriétés marquées "incomplet" sont une exception à cette règle générale.
Lorsque nous traitons votre fournisseur de données, la propriété sera marquée comme "incomplète" si nous ne reconnaissons pas chacun des éléments d'information suivants :
- Prix
- Province
- Ville
- Type de propriété
Un bien incomplet ne peut pas être consulté par le public sur Kyero. Pour qu'il soit actif, il doit être mis à jour soit à partir du compte Kyero.com, soit à partir de votre système de gestion de propriété initial.
Lorsque vous apportez des modifications à des propriétés marquées "incomplètes" à partir de votre compte Kyero.com, ces modifications seront conservées - même si nous traitons à nouveau votre fournisseur de données.
Plutôt que de "réparer" les propriétés incomplètes, le meilleur plan d'action est d'empêcher qu'une propriété soit marquée comme "incomplète" en premier lieu. Pour ce faire, il suffit de s'assurer que votre système de gestion des biens immobiliers contient tous les champs d'information obligatoires.
Le système Kyero.com utilise la base de données postale officielle pour déterminer l'emplacement exact de la propriété. Pour cette raison, vous pouvez constater qu'il y a de légères différences entre l'emplacement utilisé dans votre système de gestion de propriété et l'emplacement utilisé par Kyero.com.
Si le système Kyero ne reconnaît pas l'emplacement d'une localité donnée, il marquera la propriété comme "incomplète". Si vous mettez à jour l'emplacement avec votre système de gestion de propriété, la propriété sera mise à jour correctement dans Kyero.com.
Dans la mesure du possible, nous reprenons le type de propriété de votre système de gestion des propriétés. S'il est manquant ou ne peut être reconnu par le système Kyero.com, le bien sera marqué "incomplet". En mettant à jour le type de propriété avec le système de gestion des propriétés, vous vous assurez que la propriété est mise à jour correctement dans Kyero.com.
Le système Kyero comporte deux types de propriétés, les ventes et les locations à long terme. Lorsque le prix d'un bien est indiqué "par mois", il apparaît dans la section "Location à long terme".
Il est possible qu'une propriété soit à vendre ET à louer dans votre système de gestion des propriétés. Le système Kyero ne reconnaît pas cette fonctionnalité et nous vous suggérons de créer une propriété en double dans votre système de gestion immobilière, en marquant une propriété comme propriété locative et l'autre propriété comme propriété à vendre.
Le système Kyero.com ne contient que des propriétés en Espagne. Les propriétés qui sont situées en dehors de l'Espagne ou qui ne contiennent pas d'informations sur leur emplacement ne seront pas importées dans Kyero.com. Si vous constatez qu'une propriété a disparu de Kyero.com, vérifiez que votre système de gestion des propriétés utilise une localisation en Espagne et qu'elle n'est pas marquée "incomplète" dans votre compte Kyero.com.
Le système Kyero peut avoir un maximum de cinquante photos par propriété. Si une propriété contient plus de cinquante photos dans votre système de gestion des propriétés, elle sera importée dans Kyero.com en utilisant uniquement les cinquante premières photos.
10. Obtenir de l'aide
Si vous avez un problème ou une question qui n'a pas été expliqué ici, ou si vous trouvez une erreur dans notre documentation, n'hésitez pas à ouvrir un ticket de support pour nous contacter.
11. Informations sur la version
18/08/2020 - V3.6
- ajout du sous-noeud 'tags' à <images>
08/04/2020 - v3.5
- ajout du nœud <video_url>
- Ajout du noeud <virtual_tour_url>
- ajout du noeud <catastral>
11/08/2017 - V3.4
- ajout du noeud <country>
01/06/2016 - V3.3
- 'week' supprimé du nœud <price_freq>
11/03/2016 - V3.2
- Révision du schéma XSD pour adapter les langues supprimées
- Révision du schéma XSD pour ajuster les nœuds obligatoires
- Révision du schéma XSD pour supprimer le nœud <title> des images
- Mise à jour du validateur de flux XML pour refléter les dernières modifications et permettre de tester les droits depuis un fichier
- La longueur maximale de la balise <ref> est passée de 15 à 255
- Suppression de certaines langues : pl, ro
- La balise <desc> est maintenant obligatoire lorsqu'il n'y a pas de fonctionnalité (<features>)
10/02/2015 - V3.1
- Augmentation du nombre maximum d'images par propriété de 10 à 50
- Suppression de certaines langues : bg, cs, el, et, hu, id, ja, hi, ko, lt, lv, sk, sl, th, tr, uk, vi, zh
06/01/2014 - V3
- <feed_version> changé en 3
- Correspondance des spécifications d'importation et d'exportation de la V3
- a supprimé 'new_build' du noeud <price_freq>
- ajout d'un nœud <new_build> séparé
- réduction du nœud <currency> aux valeurs EUR, GBP et USD
- suppression des sous-nœuds de langue du nœud novo <type>
- ajout d'un nœud <surface_area>
- Ajout du nœud <location>
- ajout du noeud <energy_rating>
- ajout du noeud <url>
- ajout de sous-nœuds de langue au nœud <desc>
- ajout d'un noeud <notes>
- augmentation de la taille minimale obligatoire des images
- suppression de l'attribut <primary> des images
- suppression de l'attribut <title> des images