Interfaccia JSON Services Download

Interfaccia
Madeep
jServices Download
ver. 1.66

Il presente documento descrive l'interfaccia JSON tra i sistemi di prenotazione MADEEP e i siti
internet o portali a cui sono associati.

L'interfaccia è disponibile al seguente indirizzo:

https://back-services.com/int/portals/jServices.php?channelid=123&portalcode=1234567890

i parametri minimi per ottenere l'elenco servizi (o attività, etc.) sono:

- channelid: identificativo univoco del canale

- portalcode: un codice che agisce da controllo

Utilizzando solo questi due parametri si otterrà la lista completa in formato JSON di tutti i fornitori
(o organizer) e relativi servizi presenti nel portale. Per ottenere un listato più specifico possono
essere utilizzati ulteriori parametri, tutti facoltativi:

- lang: it/en per ottenere le informazioni in una sola lingua

- ecomid: esplicitando il codice di un ecommerce si può ottenere l'elenco di servizi del
singolo ecommerce
- uniqueid: esplicitando il codice di un singolo servizio si può ottenere solo quel singolo
servizio
- dlm: esplicitando una data ultima modifica, in formato 2012-12-21T13:37:00, si otterranno
solo i servizi modificati dopo tale data/ora
- av_from e av_to: esplicitando una data inizio e una data fine, in formato 2012-12-21, si
otterranno solo i servizi con prezzi e disponibilità reale in quel periodo

L'interfaccia restituirà una struttura json, di cui si riporta un singolo blocco/servizio in formato array
php per facilitarne la lettura, i singoli parametri saranno descritti di seguito.

Madeep Development Team - development@madeep.com

 Interfaccia JSON Services Download

{
"uniqueid": "164_37_1",
"validFrom": "2010-01-01",
"validTo": "2038-01-19",
"priceFrom": "30.00",
"address": "Viale Vittorio Emanuele II",
"zipcode": "24100",
"city": "Bergamo",
"province": "Bergamo",
"region": "Lombardia",
"nation": "Italy",
"nation_code": "IT",
"lat": "45.70179510",
"lng": "9.66712660",
"meeting": "Viale Vittorio Emanuele II 24100 Bergamo (Bergamo) Italy",
"meeting_lat": "45.70179510",
"meeting_lng": "9.66712660",
"imgUrl": "https://back-services.com/hotelimgs/ec_service_37_1.jpg",
"gallery": {
"GImage": [
"https://back-services.com/hotelimgs/ec_service_37_1_2.jpg",
"https://back-services.com/hotelimgs/ec_service_37_1_3.jpg"
]
},
"organizer": "Italian Art Guides, Piazza Pontida, Bergamo",
"burl_en": "http://hotel.madeep.com/myportal.htm?ecomid=37&serviceid=1",
"NAME_eng": "Italian Cities travel guide",
"SHORTDESC_eng": "Italian Cities travel guide",
"LONGDESC_eng": "Italian Cities travel guide",
"Details": "",
"Additional Services": "",
"burl_it": "http://hotel.madeep.com/myportal.htm?ecomid=37&serviceid=1",
"NAME_ita": "Guida delle città d'arte in Italia",
"SHORTDESC_ita": "Guida approfondita delle grandi città d'arte italiane",
"LONGDESC_ita": "Un percorso ideale per la scoperta del patrimonio storico artistico e culturale
delle principali \"capitali\" dell'arte italiana.",
"Dettagli": "Mappe, guide e tutto il resto.",
"Servizi Aggiuntivi": "Servizi addizionali per la guida",
"Come": "Come cosa perché?",
"burl_es": "http://hotel.madeep.com/myportal.htm?ecomid=37&serviceid=1",
"NAME_esp": "Guía de Ciudades de Arte de Italia",
"SHORTDESC_esp": "Guida detallada de las grandes ciudades italianas.",
"LONGDESC_esp": "Un recorrido ideal para descubrir el patrimonio historico artístico y cultural
de las mayores \"capitales\" del arte italiano.",
"Detalles": "",
"Servicios adicionales": ""
},

Madeep Development Team - development@madeep.com

 Interfaccia JSON Services Download

CAMPI NON VARIABILI PER LINGUA

- uniqueid: è l'identificativo univoco del servizio (è formato da id canale + id ecommerce + id

servizio uniti da "_", es. 481_1542_1)
- validFrom: è la prima data per la quale si può eseguire la prenotazione del servizio
- validTo: è l'ultima data per la quale si può prenotare il servizio
- priceFrom: è il prezzo unico del servizio oppure il minimo nel caso di variazioni stagionali o
prezzi diversi per più persone
- address, zipcode, city, province, region, nation e nation code: formano l'indirizzo del servizio
- lat, lng: sono latitudine e longitudine del servizio
- meeting: è l'indirizzo di un eventuale meeting point (punto di ritrovo) se specificato
- meeting_lat, meeting_lng: sono latitudine e longitudine del meeting point
- imgUrl: è la URL dell'immagine principale del servizio
- gallery: è un array di immagini secondarie utilizzabili come fotogallery del servizio
- organizer: è la ragione sociale (o il semplice nome) ed eventualmente l'indirizzo se presente
del fornitore del servizio

CAMPI IN LINGUA (*_IT, *_EN, etc.)

- burl_it: è l'indirizzo al quale reindirizzare l'utente che intende acquistare il servizio

- NAME_it: è il nome del servizio
- SHORTDESC_it: è la descrizione breve del servizio
- LONGDESC_it: è la descrizione lunga del servizio
- Details, etc.: sono i vari campi aggiuntivi, con relativi valori, variabili da canale a canale

NOTE SUL CAMPO dlm:

Dato l'uso del campo dlm (date last modification) si suggerisce una iniziale sincronizzazione
dell'intero portale, scaricando l'elenco completo dei servizi e generando le relative pagine statiche,
senza usare il parametro dlm ma tenendo poi salvata la data di quando è stata fatta la chiamata.
Dopo di questa si suggerisce di chiamare l'interfaccia con il parametro dlm, con la data dell'ultima
richiesta, per verificare se nel frattempo ci siano state delle modifiche. In questo caso l'interfaccia
restituirà SOLO i servizi modificati, NESSUN servizio nel caso di mancanza di modifiche. Questa
richiesta può essere fatta a discrezione, per esempio ogni ora. Si suggerisce invece
periodicamente, una volta al giorno per esempio, di chiamare l'interfaccia senza dlm per riottenere
tutti i servizi e verificare la corretta sincronizzazione.

NOTE SUI CAMPI av_from E av_to:

L'uso dei campi av_from e av_to è utile per sapere quali servizi sono disponibili in un intervallo di
date. Normalmente l'interfaccia restituisce tutti i servizi prenotabili ma alcuni di essi potrebbero
esserlo solo per determinati periodi o addirittura solo alcuni giorni. L'utilizzo dei campi av_from e
av_to obbliga l'interfaccia a verificare prezzi e disponibilità nel periodo selezionato e restituire solo i
servizi prenotabili in quelle date. Questa funzionalità sarebbe da usare solo per generare risultati di
ricerche per data e non per generare le relative pagine, che dovrebbero invece essere già state
generate tramite precedenti chiamate senza l'uso di questi parametri. (Nota: per ogni periodo sono
restituiti i servizi con almeno un giorno valido nel periodo, non per forza validi per tutto il periodo).

Madeep Development Team - development@madeep.com