Dettagli sulla specifica XML utilizzata in Kyero.com per importare i dettagli delle proprietà da altri sistemi Kyero.com.
Questa pagina elenca le specifiche di un provider di dati XML per l'invio di informazioni a Kyero.com. (Versione inglese)
Ultima modifica 18 agosto 2020 - V3.6
Contenuti
- Per cominciare
- Sinossi
- Linee guida e convenzioni
- Panoramica della struttura di fornitura dei dati
- Sulla programmazione dei caratteri
- Testare la struttura
- Prova la programmazione dei caratteri
- Invio di un feed di dati per la convalida
- Automatizzare gli aggiornamenti delle proprietà
- Ottenere aiuto
- Informazioni sulla versione
1. Per cominciare
- Si vedano queste note dettagliate, questo esempio di fornitura di dati e di definizione dello schema XML (XSD)
- Creare il provider di dati (sezioni 2 - 5)
- Test (sezioni 6 e 7)
- Inviarlo a Kyero.com per la convalida finale (sezione 8).
2. Sinossi
Il suo feed di dati XML contiene tutte le informazioni per un account inserzionista di Kyero.com. Abbiniamo l'URL del fornitore di dati che ci ha fornito a un account inserzionista non appena convalidiamo e approviamo il fornitore di dati.
Ogni URL del fornitore di dati può contenere solo informazioni sugli immobili per un account Kyero o un agente immobiliare. Se sta creando dei provider di dati per più agenti immobiliari, ognuno di essi deve essere disponibile in un unico URL.
Se desidera proteggere con password un fornitore di dati in modo che non sia disponibile pubblicamente, deve semplicemente fornire l'URL del fornitore di dati in uno dei seguenti formati.
- http://usuario:contrasena@paginaweb.com
Non possiamo accettare un URL da un fornitore di dati che richieda un intervento manuale (come ad esempio cliccare su un pulsante per confermare), poiché il nostro processo di fornitura di dati immobiliari è completamente automatico.
Il suo fornitore di dati immobiliari deve essere un fornitore assoluto di tutte le informazioni sugli immobili e non un fornitore incrementale. Ogni volta che elaboriamo un fornitore di dati, lo valutiamo insieme a tutte le altre proprietà di quell'account nel database Kyero. Il suo fornitore di dati deve contenere TUTTE le proprietà che desidera aggiungere o aggiornare. Non deve contenere alcuna proprietà che desidera RIMUOVERE.
Quando un immobile viene AGGIUNTO al suo database, ci sarà un nuovo record dell'immobile nel suo provider di dati. Verrà INSERITO nel nostro database e noi elaboreremo e archivieremo tutte le immagini correlate.
Se una proprietà viene AGGIORNATA nel suo database, il tag <date> del suo fornitore di dati cambierà. Quando vediamo una modifica nel tag <date>, la proprietà viene AGGIORNATA nel nostro database ed elaboriamo tutte le immagini correlate.
Se un immobile viene RIMOSSO dal suo database, non ne rimarrà traccia nel suo fornitore di dati. Rimuoviamo gli immobili e le relative immagini dal nostro database quando non c'è alcuna prova che un immobile corrisponda al suo fornitore di dati.
Per inserire, aggiornare o cancellare correttamente, dobbiamo identificare in modo coerente ogni proprietà come un'entità unica nel suo fornitore di dati. Lo facciamo utilizzando il tag <id>, che deve identificare in modo coerente e univoco ciascuna delle sue proprietà.
3. Linee guida e convenzioni
Deve codificare il suo fornitore di dati per frammentare i nuovi tag in nuove righe (il nostro parser può gestire solo un limite di caratteri di una singola riga) - inoltre, per noi è molto più facile leggere e risolvere i problemi del suo fornitore di dati. Lo utilizzi nel documento che crea il suo output XML. Quando esamina l'output XML in un editor di testo, dovrebbe vedere ogni tag su una nuova riga.
Per forzare le interruzioni di riga nei testi delle descrizioni delle proprietà, può utilizzare l'entità numerica UTF-8 .
Nelle note dettagliate le diremo quali tag deve utilizzare, cosa possono contenere e se un tag è obbligatorio o opzionale.
- I tag XML hanno questo aspetto: <beds> 4</beds>
- I commenti hanno questo aspetto: // optional numeric
Un tag può essere 'opzionale' o 'obbligatorio' e può contenere caratteri 'alfa', 'alfanumerici' o 'numerici'. Il tag <date> è l'unica eccezione in cui deve essere formattato come datetime YYYY-MM-DD HH:MM:SS
Se un tag può essere vuoto (tag opzionale) - può essere codificato in quattro modi diversi:
- <beds></beds>
- <beds>0</beds> (dove sono ammessi valori numerici)
- <beds />
- (senza tag)
Tutti i tag sono sensibili alle maiuscole e DEVONO essere sempre scritti in minuscolo: <DESC> NON è la stessa cosa di <desc>.
Non includa un URL 'senza immagine' o 'immagine a venire' per le proprietà che non hanno immagini.
Non utilizzi i tag [[CDATA]] nel suo fornitore di dati come 'soluzione rapida' ai problemi di programmazione dei caratteri. Vedere la sezione Informazioni Sulla programmazione dei caratteri.
4. Panoramica della struttura di fornitura dei dati
La struttura stessa di una proprietà si trova sul lato destro del margine di questa pagina. Il suo fornitore di dati conterrà più proprietà, ripetendo la struttura allegata con <property></property> per ciascuna.
Quando costruisce il provider di dati, veda le note dettagliate e l'esempio di feed xml.
5. Sulla programmazione dei caratteri
Ci sono cinque caratteri che devono essere programmati se si desidera utilizzarli nel provider di dati. Questo perché hanno funzioni predefinite in XML (è possibile utilizzare anche le loro entità numeriche).
- < - Simbolo minore di (<) - <
- > - Il simbolo di maggiore di (>) - >
- & - L'ampersand (&) - &
- ' - La virgoletta o l'apostrofo (') - '
- " - Le due virgole (") - "
- - Per forzare le interruzioni di riga nelle descrizioni.
Quando devono essere programmati e quando devono essere lasciati così come sono?
Ad esempio: <image id="9"> - le virgolette non sono programmate perché delimitano un attributo XML all'interno di un tag XML.
<desc>Una "bella" casa</desc> - le virgolette sono programmate perché fanno parte di una stringa di testo.
<property> non deve essere programmato come <property> o <property>.
Il testo bed & breakfast deve essere programmato come bed & breakfast o bed & breakfast - nel primo esempio utilizzando un'entità XML e, nel secondo, un'entità numerica.
In questo esempio, l'entità XML & è uguale al suo equivalente HTML. Tuttavia, in generale, le entità HTML non dovrebbero essere utilizzate nel suo fornitore di dati. Non ci dovrebbero essere entità, tag o formati HTML in un fornitore di dati.
Prima di inviare un fornitore di dati a Kyero.com, lo testi utilizzando questo validatore di caratteri, selezionando UTF-8 come schema di programmazione.
È confuso sulla programmazione dei caratteri? - Joel on Software ha un articolo molto interessante sull'argomento.
6. Testare la struttura
Una volta che ha un feed pronto per l'elaborazione, lo testi inizialmente aprendolo in un browser Mozilla (Firefox, non Internet Explorer).
Se Firefox riesce a visualizzarlo con successo, non contiene errori strutturali XML fondamentali. In caso contrario, Firefox le fornirà il numero di riga del feed che contiene il primo errore. Firefox rivelerà anche i problemi di codifica dei caratteri di base.
Una volta visualizzato il feed in Firefox, visiti questo validatore. Può testare il validatore con questo feed di esempio.
Una volta ottenuto un file XML strutturalmente solido, è pronto a testare la codifica dei caratteri.
7. Prova la programmazione dei caratteri
Visiti questo validatore di caratteri di W3.org per convalidare l'URL del suo feed.
Selezioni il tipo di codifica come: UTF-8 (Unicode, worldwide), faccia clic su Verifica.
Purtroppo, anche quando il feed è codificato correttamente, riceverà comunque degli errori. Nella parte superiore della pagina dei risultati, un feed convalidato correttamente visualizzerà:
Result: Failed validation, 1 error (Risultato: Convalida fallita, 1 errore)
o
This Page Is Tentatively Valid XML! (Questa pagina non è XML valido!) vedrà il seguente errore: Error Line 2 column 1: no document type declaration (Errore riga 2 colonna 1: dichiarazione non di questo tipo di documento)
Questo può essere ignorato senza problemi. Può anche ignorare i tre avvertimenti:
- Missing "charset" attribute for "text/xml" document (Falta "charset" atributo para documento de"texto/xml")
- Character Encoding Override in effect! (Anulación manual de la programación de caracteres funciona!)
- No DOCTYPE found! Attempting validation with XHTML 1.0 Transitional (No se ha encontrado DOCTYPE! Intento de validar con XHTML 1.0 en transición)
(Può verificare questi errori accettabili utilizzando questo esempio di fornitore di dati).
Tutti gli errori devono essere esaminati e risolti prima di inviare un fornitore di dati a Kyero.
8. Invio di un feed di dati per la convalida
Non appena dispone di un fornitore di dati che supera la convalida della programmazione e la convalida dello schema XML, apra un nuovo ticket di assistenza con l'URL del fornitore di dati (non dimentichi di indicarci per quale account inserzionista di Kyero.com si tratta).
Convalideremo il fornitore di dati in un sistema di sviluppo e le forniremo il nostro feedback di solito nello stesso giorno lavorativo.
Non invii un ticket per un fornitore di dati che presenta errori strutturali o di programmazione dei caratteri.
9. Automatizzare gli aggiornamenti delle proprietà
Non appena avremo testato con successo il suo fornitore di dati, lo elaboreremo manualmente nel sistema live di Kyero.com e la informeremo quando le proprietà potranno essere riviste.
Quando le proprietà sono online, elaboreremo il suo fornitore di dati ogni giorno alle 01:30 circa.
I fornitori di dati che non sono conformi alle nostre specifiche o che mostrano un comportamento negativo possono essere aggiornati una volta alla settimana o fermati.
È importante ricordare che deve SEMPRE utilizzare il suo sistema di gestione immobiliare originale per gestire le sue proprietà, NON il suo account Kyero.com. Quando elaboriamo il suo fornitore di dati, sostituiamo le informazioni presenti nel suo account Kyero.com.
Ciò significa che se modifica i dettagli dell'immobile utilizzando il suo account Kyero.com, queste modifiche andranno perse quando elaboreremo il suo prossimo fornitore di dati. Tuttavia, le proprietà contrassegnate come 'incomplete' rappresentano un'eccezione a questa regola generale.
Quando elaboriamo il suo fornitore di dati, la proprietà sarà contrassegnata come 'incompleta' se non riconosciamo ciascuna delle seguenti informazioni:
- Prezzo
- Provincia
- Città
- Tipo di proprietà
Una proprietà incompleta non può essere visualizzata dal pubblico su Kyero. Affinché sia attivo, deve essere aggiornato dall'account Kyero.com o dal suo sistema di gestione immobiliare iniziale.
Quando apporta modifiche alle proprietà contrassegnate come 'incomplete' dal suo account Kyero.com, tali modifiche saranno conservate - anche se elaboriamo nuovamente il suo fornitore di dati.
Piuttosto che 'aggiustare' le proprietà incomplete, la migliore linea d'azione è evitare che una proprietà venga contrassegnata come 'incompleta'. A tal fine, è sufficiente assicurarsi che il suo sistema di gestione immobiliare contenga tutti i campi informativi obbligatori.
Il sistema Kyero.com utilizza il database postale ufficiale per determinare la posizione esatta della proprietà. Per questo motivo, potrebbe riscontrare lievi differenze tra la posizione utilizzata nel suo sistema di gestione immobiliare e quella utilizzata da Kyero.com.
Se il sistema Kyero non riconosce l'ubicazione di una determinata località, contrassegnerà la proprietà come 'incompleta'. Se aggiorna la posizione con il suo sistema di gestione immobiliare, la proprietà verrà aggiornata correttamente in Kyero.com.
Se possibile, prendiamo il tipo di immobile dal suo sistema di gestione immobiliare. Se manca o non può essere riconosciuta dal sistema di Kyero.com, la proprietà sarà contrassegnata come 'incompleta'. Aggiornando il tipo di proprietà con il sistema di gestione immobiliare, si assicurerà che la proprietà venga aggiornata correttamente in Kyero.com.
Il sistema Kyero prevede due tipi di proprietà, le vendite e gli affitti a lungo termine. Quando il prezzo di una proprietà è indicato come 'al mese', verrà mostrato nella sezione 'affitto a lungo termine'.
Può essere possibile che un immobile sia in vendita E in affitto nel suo sistema di gestione immobiliare. Il sistema Kyero non riconosce questa funzione e le suggeriamo di creare una proprietà duplicata nel suo sistema di gestione immobiliare, contrassegnandone una come proprietà in affitto e l'altra come proprietà in vendita.
Il sistema Kyero.com contiene solo immobili in Spagna. Gli immobili che si trovano al di fuori della Spagna o che non contengono informazioni sulla loro ubicazione non saranno importati in Kyero.com. Se si accorge che una proprietà manca da Kyero.com, controlli che il suo sistema di gestione immobiliare utilizzi una località in Spagna e che non sia contrassegnata come 'incompleta' nel suo account Kyero.com.
Il sistema Kyero può avere un massimo di cinquanta fotografie per proprietà. Se un immobile contiene più di cinquanta fotografie nel suo sistema di gestione immobiliare, verrà importato in Kyero.com utilizzando solo le prime cinquanta fotografie.
10. Ottenere aiuto
Se ha un problema o una domanda che non è stata spiegata qui, o se trova un errore nella nostra documentazione, non esiti ad aprire un ticket di assistenza per contattarci.
11. Informazioni sulla versione
18/08/2020 - V3.6
- aggiunto il sottonodo 'tags' a <images>
08/04/2020 - v3.5
- aggiunto il nodo <video_url>
- aggiunto il nodo <virtual_tour_url>
- aggiunto il nodo <catastale>
11/08/2017 - V3.4
- aggiunto il nodo <country>
01/06/2016 - V3.3
- "week" rimosso dal nodo <price_freq>
11/03/2016 - V3.2
- Schema XSD rivisto per adattare le lingue rimosseç
- Lo schema XSD è stato rivisto per adattare i nodi obbligatori.
- Lo schema XSD è stato rivisto per rimuovere il nodo <title> dalle immagini.
- Aggiornato il validatore di feed XML per riflettere le ultime modifiche e permettere di testare le tariffe da un file.
- La lunghezza massima del tag <ref> è stata aumentata da 15 a 255.
- Rimosse alcune lingue: pl, ro
- Il tag <desc> è ora obbligatorio quando non ci sono caratteristiche (<features>).
10/02/2015 - V3.1
- Aumenta il numero massimo di immagini per proprietà da 10 a 50.
- Rimosse alcune lingue: bg, cs, el, et, hu, id, ja, hi, ko, lt, lv, sk, sl, th, tr, uk, vi, zh
06/01/2014 - V3
- <feed_version> cambiato in 3
- Le specifiche di importazione ed esportazione della V3 corrispondono
- ha rimosso 'new_build' dal nodo <price_freq>
- ha aggiunto un nodo <new_build> separato
- ha ridotto il nodo <currency> ai valori EUR, GBP e USD
- ha rimosso i sottonodi della lingua dal nodo novo <tipo>
- ha aggiunto il nodo <aree_superficiali>
- ha aggiunto il nodo <location>
- ha aggiunto il nodo <valutazione_energetica>
- ha aggiunto il nodo <url>
- ha aggiunto i sottonodi della lingua al nodo <desc>
- ha aggiunto il nodo <note>
- ha aumentato la dimensione minima obbligatoria dell'immagine
- ha rimosso l'attributo <primario> dalle immagini
- ha rimosso l'attributo <title> dalle immagini
17/01/2013 - V2.20
- Le didascalie delle immagini sono state rimosse. Se presenti, saranno scartati. Kyero ora supporta troppe lingue perché questo sia pratico da gestire.
- Esempio di alimentazione e XSD aggiornato
16/12/2008 - V2.19
- Aggiunta l'opzione 'new_build' al nodo <price_freq> per accogliere le nuove proprietà e le vendite fuori piano.
- <price_freq>sale</price_freq> continuerà ad essere utilizzato per le vendite.
27/11/2008 - V2.18
- <feed_version> cambiato in 2_1
- Aggiunto il nodo <features> per abilitare le traduzioni automatiche delle caratteristiche delle proprietà.
- Aggiunti i nodi di lingua <da>, <it>, <pt> e <ru> nel nodo <desc> per consentire traduzioni complete per ogni lingua.
10/09/2007 - V2.17
- Specifica rivista per verificare la convalida dei caratteri con il validatore W3C aggiornato.
02/05/2007 - V2.16
- Modifica delle specifiche per rimuovere l'attributo <primary> dalle immagini. Aggiunta una nota per ordinare le immagini per priorità.
19/04/2007 - V2.15
- Revisione della sezione 5 per utilizzare 3 entità numeriche.
- Aggiunto un link all'articolo di Joel on Software sulla codifica dei caratteri.
30/03/2007 - V2.14
- Schema del validatore XML semplificato, indirizzi web rivisti, numeri di versione corretti in questo documento.
06/12/2006 - V2.13
- Note riviste nella sezione 6 sulla convalida - Ora si usano XSD online e feed URL invece di caricare i file.
- Rimosso il riferimento alla convalida dei caratteri di un file caricato nella sezione 7. Rimosso il riferimento al file XSD.
23/11/2006 - V2.12
- Note riviste che rendono obbligatori i nodi <beds>, <baths>, <pool>, <built> e <plot>
12/10/2006 - V2.11
- Revisione dello schema XSD per consentire i tipi di proprietà contenenti i caratteri '/' e '-'
12/10/2006 - V2.10
- Schema XSD rivisto per consentire i tipi di proprietà contenenti spazi
28/09/2006 - V2.09
- Rivedere lo schema XSD per verificare che il tipo di proprietà non sia vuoto.
11/07/2006 - V2.08
- Rivedere lo schema XSD per verificare che i nodi <feed_version> e <ref> siano validi
07/07/2006 - V2.07
- Note riviste sulla forzatura delle interruzioni di riga con n
23/06/2006 - V2.06
- Note riviste sulla codifica dei caratteri UTF-8. Rimosse le tabelle UTF-8 e ASCII.
14/06/2006 - V2.05
- Creata questa pagina e i documenti associati
- Modificata la codifica dei caratteri in UTF-8
- Aggiunte procedure di verifica dello schema e della codifica dei caratteri
- Rimossa l'opzione di caricamento FTP
12/05/2006 - V2.04
- Le note del nodo <date> sono state modificate per specificare un formato di data standard
19/04/2006 - V2.03
- Aggiunte note al nodo <desc> sulle interruzioni di riga
07/02/2006 - V2.02
- Aggiunti i nodi <surface_area>, <built> e <plot> ai record di proprietà
24/11/2005 - V2.01
- Sono state aggiunte delle note sulla codifica e su come &
- non usi il tag CDATA
- ha aggiunto una nota sul fatto che il tag Descrizione di w3.org è ora opzionale
- Aggiunta una nota sulla formattazione dei prezzi
- Aggiunta nota sul fatto che i nodi <leasehold> e <part_ownership> sono applicabili solo quando <price_freq> è impostato su 'sale'
- Aggiunto il nodo <primario> alle note dell'immagine
- Aggiunta la nota che tutti i nodi devono essere minuscoli
- Ha cambiato il nodo <Kyero> in <kyero>
27/05/2005 - V2.00
- Bozza iniziale dell'importazione V2