VIAMICHELIN REST API


BESTMAP

Description

Accès aux métadonnées de la meilleure carte statique permettant d'afficher une zone géographique spécifiée par ses limites. L'url d'accès à la carte est fourni dans la réponse.

URL

http://apir.viamichelin.com/apir/1/bestMap.{output}/{geobounds}/{size}/{lg}?actions=dx:{dx};dy:{dy};zoom:{zoom}%%&displayicons={displayicons}&iti_trace={iti_trace}&showCopyright={showCopyright}&poi_icons={poi_icons}&authkey={authkey}&charset={charset}&ie={ie}&callback={callback}&signature={signature}

Format de sortie

xml, json

Comptabilisation

Accès à une définition de carte = une requête facturée. L'accès à la carte elle-même n'est pas facturé.

Versions du service

VersionDescription
1.0 Ajouté à l'API REST

 

Paramètres d'entrée

NomObligatoire?TypeDescriptionDéfaut
geobounds oui float:float:float:float emprise géographique contenue par la carte, sous la forme minLon:minLat:maxLon:maxLat. N/A
size oui positive int:positive int Dimensions en pixels de la carte au format width:height. N/A
lg oui string Code langue (fra, deu, spa, ita, eng, ces, dan, nld, fin, int, nor, pol, por, swe) N/A
actions non dx:int;dy:int;zoom:int Actions applicables sur la carte d'origine. dx indique le décalage horizontal en pixels, dy le décalage vertical, zoom la variation de niveau de zoom qui peut être une valeur positive (zoom in) ou négative (zoom out) vide
displayicons non int:float:float:string
[:positive int:positive int]
POI à représenter sur la carte au format id:longitude:latitude:id icône client:largeur:hauteur. Les icônes sont des données client hébergées chez ViaMichelin. Plusieurs POI peuvent-être affichés. vide
iti_trace non string Trace encodée retournée par le service Route à afficher sur la carte. La plupart du temps, ce paramètre doit-être envoyé en POST à cause de sa grande longueur. vide
showCopyright non bool Affiche le copyright ViaMichelin dans le coin bas-gauche de l'image. false
poi_icons non dbid:poiid Identifiant du POI que l'on souhaite afficher en complément sur la carte. Ce paramètre peut-être multivalué. vide
authkey oui string Clef d'authentification. Cela peut-être une clef JS, un token généré par la fonction token ou l'identifiant du client en cas de signature de la requête (voir le paramètre signature) N/A
signature non string Signature de la requête avec l'algorithme HMAC-SHA1 où la clef secrète est le mot de passe du client. Si la requête est signée, authKey doit contenir l'identifiant du client, et expires doit-être valorisé. La signature s'applique sur des URL ayant leurs chaînes de caractères encodées. vide
expires non sauf si signature défini date Date GMT d'expiration de la requête au format yyyy-MM-dd'T'HH:mm:ss.SSS`'Z. vide
callback oui si json string Nom de la fonction de callback à lancer (n'a de sens que si le format vaut json) vide
charset non string Encodage des caractères dans la réponse 'ISO-8859-1'
ie non string Encodage des caractères dans la requête 'ISO-8859-1'

 

Restrictions

  • Les limites de cartes sont à spécifiables uniquement dans des coordonnées WGS84.
  • La hauteur et largeur de l'image sont techniquement plafonnés à 900 pixels.

 

Exemples de requêtes

 

Structure de la réponse

  • La structure est de type map open in new tab
  •  

Veuillez noter que les champs retournés qui ne seraient pas expliqués dans ce document correspondent à des champs à usage interne de ViaMichelin. Ils peuvent évoluer à tout moment et ne devraient pas être utilisés. Leur présence traduit le fait que ViaMichelin utilise en interne les mêmes services et la même infrastructure que ceux mis à disposition de ces clients.

Retour haut de page