GEOTRAILS

Transcription

GEOTRAILS
GEOTRAILS
DOCUMENTATION WEBMASTER
GEOTRAILS - DOCUMENTATION WEBMASTER
GEOMATIC INGENIERIE SA
Objectifs
Ce document s'adresse au webmaster voulant intégrer les randonnées saisies avec l'éditeur de
randonnées sous geotrails.
L'intégration peut se faire simplement via une iframe ou en effectuant un travail autour des
données retournées via l’API Geotrails.
Contexte
L’affichage par défaut est une liste html contenant toutes les randonnées publiques de votre
environnement geotrails.
Lors de l'appel à www.geotrails.ch, vous allez pouvoir déterminer les critères de recherche et les
caractéristiques de l'affichage sur votre site.
Ce document vous présente ces divers paramètres à passer lors de l'appel afin de régler au mieux
la présentation de vos randonnées.
Intégration via une iframe
L'affichage des randonnées provenant de www.geotrails.ch peut se fait à l'intérieur d'une iframe.
Cette technique permet d'afficher à l'intérieur d'un site des données en provenance d'un autre
site.
Le code html pour mettre en place l'appel à la forme suivante :
<iframe
src="http://www.geotrails.ch/<region>"name="moniframe" id="moniframe" marginwidth="10" marginheight="10"
width="600" height="800"
align="top" scrolling="auto" frameborder="0"
hspace="0" vspace="0" style="z-index:0" border="0">
<br>
Votre browser ne supporte pas les iframe.
<br>
<a href="http://www.geotrails.ch/<region>>rendez vous sur www.geotrails.ch</a>
</iframe>
PAGE 2 / 9
12/07/11
GEOTRAILS - DOCUMENTATION WEBMASTER
GEOMATIC INGENIERIE SA
Les paramètres obligatoires sont :
Paramètres
Objets
region
Le nom de votre région
width
Précise la largeur de l'iframe dans votre site.
height
Précise la hauteur de l'iframe dans votre site.
Cette url affiche toutes les randonnées publiques disponibles pour la région indiquée.
Des paramètres optionnels peuvent être passés.
Ils permettent de définir l'apparence et le contenu de la liste des randonnées.
Les paramètres sont passés ajoutant des arguments à l'url initiale.
Par exemple :
http://www.geotrails.ch/<region>/index.php?<param1>=<val1>&<param2>=<val2>
Il est possible de spécifier des critères multiples pour activityId,difficultyId et destinationId.
La liste des valeurs doit être séparées par des virgules.
Par exemple, la liste des randonnées de type VTT et vélo :
http://www.geotrails.ch/<region>/index.php?activityid=2,5
Paramètres
Objet
cssFile
Précise l'utilisation d'une feuille de style particulière. La css permet de configurer l'affichage de la
liste.
lang
Précise la langue pour l'affichage (fr,de,en)
searchForm
Affichage de la forme de recherche (1, 0)
destinationId
Destination choisie pour la recherche
Les valeurs pour destination dépendent de la région globale choisie
activityId
Activitée de la randonnée
0 : Non défini
1 : Marche
2 :VTT
3 : Randonnée
4 : Course à pied
5 :Vélo
6 : Ski de randonnée
7 : Cheval
8 : Raquette à neige
9 : Rollerblades
10 : Nordic walking
11 : Ski de fond
12 :Via ferrata
13 : Autre
PAGE 3 / 9
12/07/11
GEOTRAILS - DOCUMENTATION WEBMASTER
thema
Thème de la randonnée
0 : Non défini
1 : Excursion plusieurs jours
2 : Excursion pour famille
3 : Randonnée guidée
4 : Randonnée et gastronomie
5 : Randonnée et culture
6 : Randonnée en boucle
7 : Randonnée sur la plaine
8 : Randonnée dans une réserve naturelle
9 : Route montagne
10 : Avec transport bagages
11 : Randonnée en hiver
12 : Sentier didactique
13 : Randonnée pour enfants (dès 10 ans)
14 : Autre
difficultyId
Difficulté de la randonnée
0 : Non défini
1 : Facile
2 : Moyenne
3 : Difficile
sortBy
Tri ascendant de la liste sur la valeur passée
duration_m,activityId,difficultyId,iti_z_min,iti_z_max
duration_m
Temps en min de la randonnée
Nb : L'utilisation des opérateurs est possible ex : duration_m=>1
iti_z_min
Altitude minimum
Nb : L'utilisation des opérateurs est possible ex : iti_z_min=>2000
iti_z_max
Altitude maximum
Nb : L'utilisation des opérateurs est possible ex : iti_z_max=<2000
keyword
Mot clef de recherche
Recherche sur les champs descriptifs de la randonnée
GEOMATIC INGENIERIE SA
Exemples d’utilisation
Toutes les randonnées publiées par l'office du tourisme
http://www.geotrails.ch/tourismvd/
Toutes les randonnées publiées par l'office du tourisme avec le masque de recherche
http://www.geotrails.ch/tourismvd/index.php?searchForm=1
Toutes les randonnées faciles publiées par l'office du tourisme
http://www.geotrails.ch/tourismvd/index.php?difficultyId=1
Toutes les randonnées faciles de plus de 2 heures publiées par l'office du tourisme
http://www.geotrails.ch/tourismvd/index.php?difficultyId=1&duration_m=>120
Toutes les randonnées faciles publiées par l'office de tourisme de Montreux
http://www.geotrails.ch/tourismvd/index.php?difficultyId=1&member_id=7458
Le webmaster peut configurer certains éléments de la liste produite en indiquant une référence
d'une feuille de style css.
PAGE 4 / 9
12/07/11
GEOTRAILS - DOCUMENTATION WEBMASTER
GEOMATIC INGENIERIE SA
Cette feuille de style contient des balises définissant la présentation de certains éléments de liste
ou de la fiche de détail de la randonnée.
Autres URL
En marge de la liste des randonnées, il est possible d'avoir accès à d'autres contenus liés à vos
randonnées (carte,fichiers GPS,kmz,profi,3d,...)
La liste des liens internet ci dessous vous indique les exemples d'URL disponibles.
• Détail d'une randonnée au format HTML
http://www.geotrails.ch/detail.php?trailid=113284
• Carte randonnée (moteur google maps)
http://www.geotrails.ch/gmap_view.php?trailid=113284
• Carte randonnée (moteur geomatic mapapi)
http://www.geotrails.ch/omap_view.php?id_point_interet=113284
• Profil
http://www.geotrails.ch/profil.php?trailid=113284
• Module 3D, nouveau dans geotrails http://www.geotrails.ch/3d.php?trailid=113284
• Fichier KML,google earth http://www.geotrails.ch/kml.php?trailid=113284
• Fichier KMZ,google earth http://www.geotrails.ch/kmz.php?trailid=113284
• Fichier GPX 1.1
http://www.geotrails.ch/gpx.php?trailid=113284
Utilisation de l’API geotrails
Le résultat des requêtes faite via l’API ne seront plus ici du code HTML intégrable directement
dans un site internet mais des données brutes au format XML ou JSON dans un encodage UTF-8.
Le webmaster devra ici faire un travail d’interprétation et de mise en page des données reçues.
Le résultat obtenu sera bien mieux intégré au site final, il permettra aussi un référencement bien
meilleur de vos randonnées par les moteurs de recherche.
Le formalisme de filtre est repris permettant la mise en place de forme de recherche
personnalisée. Certains nouveaux paramètres sont définis en entrée (page,format,export,...).
L'accès à l'API est subordonnée à autorisation de la part de Geomatic Ingénierie SA.
PAGE 5 / 9
12/07/11
GEOTRAILS - DOCUMENTATION WEBMASTER
GEOMATIC INGENIERIE SA
Obtention de la liste des randonnées.
Paramètres
Objet
lang
Précise la langue pour l'affichage (fr,de,en)
destinationid
Destination choisie pour la recherche
activityid
Activitée de la randonnée
thema
Thème de la randonnée
difficultyid
Difficulté de la randonnée
sortby
Tri ascendant de la liste sur la valeur passée
duration_m
Temps en min de la randonnée
iti_z_min
Altitude minimum
iti_z_max
Altitude maximum
keyword
Mot clef de recherche
page
Permet de préciser la page retourné.
Par défaut 10 randonées par liste, page 1 retourné
export
Si export=all, export toutes les randonnées correspondantes aux critères sont retournées
format [xml,json]
Par defaut xml
trailId
Identifiant de la randonnée
Exemple :
La requête http://www.geotrails.ch/tourismvd/api.php retournera la première page des randonnées
publiques de l'office de tourisme du canton de Vaud.
<trails>
<trail id="110011">
<member_id>60355</member_id>
<name>110011</name>
<link></link>
<created>2011-06-16</created>
<activity_id>1</activity_id>
<difficulty_id>2</difficulty_id>
<title>La balade de Mimont (Col des Mosses)</title>
<sump_up>Cette randonnée sous le flanc du Pic Chaussy offre une jolie vue sur la vallée des Ormonts. La
descente sur La Comballaz sillonnant à travers les sous-bois apporte de la fraîcheur. Un parcours agréable sans pour
autant tomber dans la monotonie?</sump_up>
<duration_m>155</duration_m>
<start_point>
<lng>7.10207414115738</lng>
<lat>46.3963634527218</lat>
</start_point>
</trail>
<trail id="105464">
...
Le résultat retourné contient le nombre de page total (10 éléments par page) et la page courante
...
<pages>
<total>6</total>
<current>1</current>
PAGE 6 / 9
12/07/11
GEOTRAILS - DOCUMENTATION WEBMASTER
GEOMATIC INGENIERIE SA
</pages>
</trails>
La requête http://www.geotrails.ch/tourismvd/api.php?activityId=1&export=all&format=json
retournera toutes les randonnées publiques de type marche de l'office de tourisme du canton de
Vaud au format json.
L'api permet aussi d'avoir accès au détail d'une randonnée.
Les données complètes de la randonnées sont retournées au format XML (defaut) ou json. La
langue par défaut est le français (fr).
Lors de l'appel à l'API il faut préciser l'identifiant de la randonnée : trailid.
Exemple d'appel
http://www.geotrails.ch/tourismvd/api.php?trailid=110011
Intégration cartographique
Pour améliorer, la visualisation et le référencement de vos randonnées sur votre site, il est possible
d’intégrer ces dernières directement dans vos pages et d’afficher ces dernières au dessus de
véritables cartes de randonnées topographique (swisstopo pour la Suisse, IGN pour la France,...).
Voir ci contre, un exemple des différents fonds cartographiques disponibles.
Le moteur cartographique peut être Google Maps ou MapApi, solution développé par Geomatic et
basée sous Openlayer.
Dans les deux cas cependant, ceci nécéssite quelques légers développement et l’obtention de clefs
d’autorisation de la part de Geomatic Ingénierie.
Intégration via Google Maps
Les données cartographiques sont accessibles via l'obtention d'une clef.
Pour obtenir cette clef vous devez rajouter à votre page html une référence au javascript ci
dessous : http://mapapi.swissgeo.ch/swissgeoMKey.api
ex : <script type="text/javascript" src="http://mapapi.swissgeo.ch/swissgeoMKey.api"></script>
Pour obtenir votre clef, vous devez instancier l'objet swissgeoMKey
L'attribut key de votre objet, va alors contenir une clef correcte en fonction du/des noms de
domaine que vous nous avez transmis Sous Google Maps, les données peuvent être affichées sous forme de overlays ou de fond
cartographique (maptype).
Dans le cas qui nous concerne, vous voulez afficher un fond cartographique (swisstopo) et une
randonnée devra venir s’afficher par dessus.
Ceci va se faire en spécifiant un mapttype particulier et en passant la clef obtenue lors de l'appels
des tuiles PAGE 7 / 9
12/07/11
GEOTRAILS - DOCUMENTATION WEBMASTER
GEOMATIC INGENIERIE SA
var topoch = new google.maps.ImageMapType({
getTileUrl: function(ll, z) {
mcn=parseInt((Math.random()*10000)%4)+1;
wmscUrl="http://mc"+mcn+".swissgeo.ch/wms-c/"+swissgeoMKey.key+"/topomaps/1.0.0/ch/" + z +
"/" + ll.x + "/" + ll.y + ".png";
return wmscUrl;
},
tileSize: new google.maps.Size(256, 256),
isPng: true,
minZoom: 9,
maxZoom: 15,
opacity:0.6,
name: "Swisstopo",
alt: "topo ch"
});
L’affichage de votre randonnée va se faire via l’utilisation d’un overlay de type kml. (cf la
documentation Google Maps Api).
Un exemple d’utilisation est visualisable lorsque vous appeler le détail d’une randonnée grâce aux
url standards de Geotrails.
exemple : http://www.geotrails.ch/detail.php?trailid=113284
Intégration via MapApi
L’intégration via MapApi est plus simple.
Elle se référencant le script mapapi avec la clef obtenue et en indiquant le fichier kml de votre
randonnée.
<html>
<head>
<title>KML</title>
<script language="javascript" charset="utf-8" src="http://mapapi.swissgeo.ch/mapapi.js?
key=66efadf772cf66ed44f6efd7aca30f73"></script>
<script language="javascript">
window.onload = function() {
GIMaps = new GIMaps("map");
GIMaps.addLayer("test.kml",{usePopup:true,setCenter:false});
};
</script>
<link href="basic.css" rel="stylesheet" type="text/css">
</head>
<body>
<div id="map" style="width:500px;height:400px;margin-top:10px;margin-bottom:10px;"></div>
</body>
</html>
voir l’exemple ci contre.
PAGE 8 / 9
12/07/11
GEOTRAILS - DOCUMENTATION WEBMASTER
GEOMATIC INGENIERIE SA
Historique
Date
Auteur
Objet
03/05/2006
MR
Création
23/05/2006
MR
Prise en compte du paramètre resortId
27/01/2011
MR
Mise à jour spécificités geotrails.ch
12/05/2011
MR
Ajout paramètre destinationId
24/06/2011
MR
Documentation API et url d'accès
01/07/2011
MR
Critères multiples
21/07/2011
MR
Refonte documentation et accès cartographiques
PAGE 9 / 9
12/07/11