ViaMichelin - JavaScript API V2 - Documentation

Historique

Chargement de l'API

<script src="http://apijsv2.viamichelin.com/apijsv2/api/js?key=KEY&lang=LANG" type="text/javascript"></script>

Paramètres

Fonction VMLaunch

Tous les objets de services disponibles dans ViaMichelin JavaScript API v2 sont instanciés par l'intermédiaire de la fonction VMLaunch.

Paramètres

Méthodes communes aux objets de service

Classe Error

Objets transverses à l'API

GeoPoint

Point

POIId

Size

Services et classes exposés

• ViaMichelin.Api.Map
• ViaMichelin.Api.Map.Layer
• ViaMichelin.Api.Map.Marker
• ViaMichelin.Api.Map.MarkerClusterer
• ViaMichelin.Api.Map.ComplexLayer
• ViaMichelin.Api.Map.PolyLine
• ViaMichelin.Api.Map.Polygon
• ViaMichelin.Api.Map.Circle
• ViaMichelin.Api.Map.GroundImage
• ViaMichelin.Api.Geocoding
• ViaMichelin.Api.Completion
• ViaMichelin.Api.Itinerary
• ViaMichelin.Api.Poi
• ViaMichelin.Api.Export
• ViaMichelin.Api.Import
• ViaMichelin.Api.Import.AdminArea
• ViaMichelin.Api.Weather

Service Map

Map est en charge de la présentation des cartes et de la navigation associée. Il est lancé par VMLaunch().

Objet de paramétrage MapConfig

Préfixe des constantes: ViaMichelin.Api.Constants.Map

Paramètres dédiés aux mobiles et tablettes.

Méthodes

Liste des méthodes accessibles sur l'objet de service Map (que l'on obtient via la callback onInit ou onSuccess).

Evènements

Facturation

Une requête facturée = chargement initial de carte, toute action de zoom/dezoom et déplacement de carte, géocodage du centre de carte (si center est une adresse). L'usage de la mini-carte de navigation double les requètes. La présentation de la météo double également les requétes.

Principaux exemples concernés

• Hello World!
• Créer une carte
• Présenter l'information trafic
• Jouer avec la lumière et l'espace

>Classe Layer

Layer est la classe de base des objets graphiques affichés sur la carte. Elle n'est pas instanciée directement.

Principaux exemples concernés

• Insérer des objets graphiques

Classe Marker

Marker est en charge des marqueurs affichés sur la carte. Elle est instanciée par new et hérite de Layer.

Objet de paramétrage MarkerConfig

Méthodes

Evènements

Classe MarkerClusterer

MarkerClusterer est en charge de la gestion de grosses collections d'objets de type Marker et de leur regroupement en clusters en fonction de leur répartition spatiale. Les calculs se faisant sur dans le navigateur, le nombre de POIs raisonnablement gérables est dépendant de la plate-forme du navigateur (de quelques centaines à quelques milliers).
Elle est instanciée par new mais n'hérite pas de Layer: la carte est directement passée en paramètre du constructeur.

Paramètres du constructeur

Méthodes

Principaux exemples concernés

• Gérer l'affichage de centaines de POI

Classe ComplexLayer

ComplexLayer aggrège des objets graphiques de type Layer. Elle est instanciée par new et hérite de Layer.

Méthodes

Classe PolyLine

PolyLine est en charge des objets graphiques de type polyligne. Elle est instanciée par new et hérite de Layer.

Paramètres du constructeur

Méthodes

Evènements

Classe Polygon

Polygon est en charge des objets graphiques de type polygone. Elle est instanciée par new et hérite de Layer.

Paramètres du constructeur

Méthodes

Evènements

Classe Circle

Circle est en charge des objets graphiques de type cercle. Elle est instanciée par new et hérite de Layer.

Paramètres du constructeur

Méthodes

Evènements

Classe GroundImage

GroundImage est en charge des objets graphiques de type image rectangulaire. Elle est instanciée par new et hérite de Layer.

Paramètres du constructeur

Evènements

Service Geocoding

Geocoding est en charge du géocodage et du géocodage inverse. Il est lancé par VMLaunch().

Objet de paramétrage GeocodingConfig

Objet retourné par onSuccess

Un tableau d'objets de type LocationResponse dans le cas d'un géocodage (inverse) simple. L'ordre du tableau de réponses est par correlation décroissante avec les paramètres de la requête.
Un tableau de tableaux d'objets de type LocationResponse dans le cas de géocodages (inverses) multiples. L'ordre du tableau de réponses est le même que l'odre du tableau de paramètres.

{
	coords : {
		lon : /* double */,		//longitude
		lat : /* double */,		//latitude
	},
	id : /* string */,			//LocId du lieu
	address : /* string */,			//rue
	postalCode : /* string */,			//code postal
	city : /* string */,			//ville
	countryISO : /* string */,		//code ISO du pays
	countryOfficial	: /* string */,		//code internationnal des plaques d'immatriculation du pays
	countryLabel : /* string */,		//nom du pays
	area : /* string */,		//Entité administrative englobante
	significance  : /* string */,		//Importance du lieu sur l'echelle ViaMichelin (basée sur la démographie, l'attrait touristique, l'importance administrative
	formattedAddressLine : /* string */,	//Adresse formatée
	formattedCityLine : /* string */,	//Ville formatée

	release () : /* Méthode de  libération de l'objet (nettoyage de la mémoire). */,
}

Facturation

Une requête facturée = un géocodage élémentaire (une seule adresse) ou un géocodage inverse élémentaire (une seule paire de géo-coordonnées).

Principaux exemples concernés

• Créer une liste de pays
• Lever l'ambiguïté d'une adresse

Service Completion

Completion est en charge d'enrichir un formulaire HTML de saisie d'adresse à 3 champs avec la complétion de saisie. Il est lancé par VMLaunch().

Objet de paramétrage CompletionConfig

Principaux exemples concernés

• Utiliser la complétion de saisie

Service Itinerary

Itinerary est en charge du calcul d'itinéraire. Il est lancé par VMLaunch().

Objet de paramétrage ItineraryConfig

Préfixe des constantes: ViaMichelin.Api.Constants.Itinerary

Objet retourné par onSuccess

Un objet de type ItiResponse si aucune recherche de POIs n'est associée (voir le paramètre pois ci-dessus), ou 2 objets de type ItiResponse et PoiListResponse.

{
	header: {
		vehicle 	: /* int */,
		itiType 	: /* int */,
		idx 		: /* int */,
		itidate 	: /* string */,
		startMapURL : /* string */,
		destMapURL  : /* string */,
		summaries 	: [ {
				index 		: /* int */,
				names 		: /* array */
				totalDist 	: /* int */,
				totalTime 	: /* int */,
				motorwayDist: /* int */,
				motorwayTime: /* int */,
				pleasantDist: /* int */,
				pleasantTime: /* int */,
				drivingDist	: /* int */,
				drivingTime : /* int */,
				consumption : /* double */,
				tollCost 	: {
					moto 		: /* int */,
					car 		: /* int */,
					caravan 	: /* int */,
					pl2 		: /* int */,
					pl3 		: /* int */,
					pl4 		: /* int */,
					pl5 		: /* int */
				},
				CCZCost 	: {
					moto 		: /* int */,
					car 		: /* int */,
					caravan 	: /* int */,
					pl2 		: /* int */,
					pl3 		: /* int */,
					pl4 		: /* int */,
					pl5 		: /* int */
				},
				fullMapURL : /* string */
		}]
	},
	itiTrace: {
		...
	},
	roadSheet: {
		...
	},

	getLayer()  : /* Méthode de récupération de l'objet graphique associé à l'itinéraire */,
	release () : /* Méthode de  libération de l'objet (nettoyage de la mémoire). */,
}

Facturation

Une requête facturée pour la recherche d'un itinéraire, chaque gécodage d'étape (si steps contient des adresses) et la recherche de POIs (si pois est valorisé).

Principaux exemples concernés

• Faire un calcul d'itinéraire
• Construire un distancier

Service Poi

Poi est en charge de la recherche de proximité. Il est lancé par VMLaunch().

Objet de paramétrage PoiConfig

Préfixe des constantes: ViaMichelin.Api.Constants.Poi

Objet retourné par onSuccess

Un objet de type PoiResponse si le service demandé est POI.

{
	id : /* String */,
	db : /* String */,
	lg : /* String */,
	name : /* String */,
	translatedName : /* String */,
	encodedName : /* String */,
	location : {
		coords :  {
			lon : /* double */,		//longitude
			lat : /* double */		//latitude
		},
		formattedAddressLine : /* String */,
		formattedCityLine : /* String */,
		streetNumber : /* String */,
		streetLabel : /* String */,
		city : /* String */,
		postalCode : /* String */,
		area : /* String */,
		countryISO : /* String */,
		countryOfficial : /* String */,
		countryLabel : /* String */
	},
	datasheet : {	
		iconId : /* integer */,
		geolvl : /* String */,
		tel : {	
			number : /* String */,
			intNumber : /* String */
		},
		fax : {	
			number : /* String */,
			intNumber : /* String */
		},	
		email : /* String */,
		web : /* String */,
		url : /* String */,
		dataPath : /* String */,
		metanumList : /* array of {idx, value} */,
		metastringList : /* array of {idx, value} */,
		descList : /* array of {idx, lib, visible, value} */,
		photoList : /* array of {idx, value} */,
	},

	getLayer()  : /* Méthode de récupération de l'objet graphique associé au POI */,
	release () : /* Méthode de  libération de l'objet (nettoyage de la mémoire). */,
}

Un objet de type PoiListResponse si le service demandé est autre que POI.

{
	nbMatches : /* integer */,
	nbHits : /* integer */,
	nbFound : /* integer */,
	startIdx :  /* integer */,
	poiList : [
		{
			dist: /*float*/, 				//distance en m entre le centre de recherche et le POI
			time: /*int*/,					//temps de parcours par la route en s entre le centre et le POI
			poi: /*PoiResponse*/
		}
		...
	],

	getLayer()  : /* Méthode de récupération de l'objet graphique associé à la liste de POIs.*/,
	release () : /* Méthode de  libération de l'objet (nettoyage de la mémoire). */,
}

Facturation

Une requête facturée pour la recherche de POIs et le gécodage du centre de recherche (si center ou steps contient une adresse).

Principaux exemples concernés

• Faire une recherche de proximité
• Gérer l'affichage de centaines de POI
• Faire une recherche le long d'un itinéraire

Service Export

Export est en charge des exports de géo-données pour les navigateurs GPS. Il est lancé par VMLaunch().

Objet de paramétrage ExportConfig

Préfixe des constantes: ViaMichelin.Api.Constants.Export

Objet retourné par onSuccess

Un objet de type ExportResponse.

{
	url 	: /* string */,
}

Principaux exemples concernés

• Faire une recherche de proximité

Service Import

Import est en charge des imports de géo-données pour les dessiner sur la carte sous la forme d'objets graphiques de type marqueurs, polylines et polygones. Il est lancé par VMLaunch().

Objet de paramétrage ImportConfig

Préfixe des constantes: ViaMichelin.Api.Constants.Import

Objet retourné par onSuccess

Un objet de type ComplexLayer.

Principaux exemples concernés

• Importer des géo-données (geoJSON)

ServiceAdminArea

AdminArea est en charge de présenter sur la carte un découpage administratif sous la forme de polygones (hébergés chez ViaMichelin). Il est lancé par VMLaunch().

Objet de paramétrage AdminAreaConfig

Préfixe des constantes: ViaMichelin.Api.Constants.Import.AdminArea

Objet retourné par onSuccess

Un objet de type ComplexLayer.

Principaux exemples concernés

• Utiliser le découpage administratif

Service Weather

Weather est la classe en charge de la recherche des informations météorologiques. Il est lancé par VMLaunch().

Objet de paramétrage WeatherConfig

Préfixe des constantes: ViaMichelin.Api.Constants.Weather

Objet retourné par onSuccess

Un objet de type WeatherResponse. Si une donnée n'est pas disponible, elle est valorisée à [prefix].NO_DATA. Consulter la liste des prévisions possibles.

{
	name 		: /* string */,
	location : {
		coords : {
			lon : /* double */,		//longitude
			lat : /* double */,		//latitude
		},
	},
	dist 		: /* integer */,
	observation: {
		dayReport 		: /* string as DD/MM/YY */,
		hourReport 		: /* string as HH:MM */
		image : {
			iconId 		: /* integer */,
			mapIconPath 		: /* string */,
		},
		imageLabel 		: /* string */,
		temperatureMesured 		: /* float */,
		temperatureApparent 		: /* float */,
		windSpeedInfo 		: /* float */,
		windDirectionInfo 		: /* string */,
		humidityInfo 		: /* float */,
		visibilityInfo 		: /* string */,
		sunRise 		: /* string as ISO-8601 date*/,
		sunSet 		: /* string as ISO-8601 date*/,
		moonRise 		: /* string as ISO-8601 date*/,
		moonSet 		: /* string as ISO-8601 date*/
	},
	forecastList : [{ /* Forecast structure */
		dayForecast 		: /* integer */,
		dayReport 		: /* string as DD/MM/YY */,
		hourReport 		: /* string as HH:MM */
		image : {
			iconId 		: /* integer */,
			mapIconPath 		: /* string */,
		},
		imageLabel 		: /* string */,
		windSpeedInfo 		: /* float */,
		windDirectionInfo 		: /* string */,
		temperatureMinInfo 		: /* float */,
		temperatureMaxInfo 		: /* float */,
		fog 		: /* integer */,
		rainFall 		: /* integer */,
		snowRoad 		: /* integer */,

		getForecast()   : /* Méthode de récupération d'une structure HTML de la prévision  */,
	}],
	todayForecastList : [{ /* Same forecast structure */}],

	getStationForecasts()  : /* Méthode de récupération d'une structure HTML des prévisions */,
	getStationObservation() : /* Méthode de récupération d'une structure HTML des observations */,
	getStationCalendar()  : /* Méthode de récupération d'une structure HTML de l'éphéméride  */,
		getLayer()  : /* Méthode de récupération de l'objet graphique associé à la liste de POIs.*/,
	release () : /* Méthode de  libération de l'objet (nettoyage de la mémoire). */,
}

Facturation

Une requête facturée pour chaque recherche de météo et le géocodage du centre de recherche (si center est une adresse).

Principaux exemples concernés

• Exploiter la météo