API Piattaforma BikeSquare
La piattaforma BikeSquare espone delle API che consentono ai programmatori di sviluppare siti ed applicazioni sfruttandone le potenzialità
L
a piattaforma BikeSquare espone le seguenti API in formato json:
- GetPercorso(x)
- GetPoi(x)
- GetPagina(x)
- GetMenu(x)
- ListPercorsi
- ListPoi
Il parametro x fa riferimento all'identificativo univoco di ogni risorsa, che può essere reperito a priori o tramite le funzioni ListPercorsi e ListPoi. Sulla piattaforma si definisce un menu specifico che contiene l’albero dei contenuti che dovranno essere esposti tramite API . Questi contenuti potranno essere di qualunque tipo di contenuto presente sul sito. La proposta di utilizzare un menu per individuare i contenuti da presentare alle API risponde a molteplici esigenze:
- semplificare l'utilizzo del Backoffice agli amministratori (che non devono imparare ad utilizzare un nuovo strumento, ma utilizzano il normale menu a cui sono abituati)
- gestire nativamente i permessi. Il menu non mostra automaticamente i contenuti che non sono pubblicati o quelli per cui l’utente richiedente non ha i permessi di accesso
- gestire alberature. A differenza di un sistema di flag che permetterebbe di presentare solo una lista di elementi da visualizzare sull'APP, il menu consente di creare una gerarchia di contenuti da trasferire.
L'APP (o eventuali altri siti con cui si dovrà interfacciare il sistema) potranno in ogni caso interrogare il server web per ottenere l’elenco di tutti i punti di interesse e di tutti i percorsi, in modo da poterli visualizzare nella maniera che ritengono più opportuna.
OpenData
La piattaforma BikeSquare può esporre in modo da garantire l'apertura verso altri sistemi, in ottica OpenData, in particolare:
-
Tutti i percorsi sono accessibili e scaricabili in formati aperti (KML e GPX)
-
Tutti i percorsi sono incorporabili in altri siti in maniera trasparente, tramite un embed di iframe.
-
Ad esempio il sito TerreDeiSavoia ha utilizzato i percorsi di cicloturismo.piemonte.it all'interno delle proprie pagine dedicate al percorso CycloMonviso.