VIAMICHELIN REST API


findpoinearroute

Description

Cette fonction recherche les POI à proximité d'un itinéraire. Elle retourne une liste de POIs statiques (POI client hébergés chez ViaMichelin), ordonnée par distance croissante de leur point de raccrochement à l'itinéraire avec le point de départ. Le calcul s'effectue par la route.

URL

http://apir.viamichelin.com/apir/1/FindPOINearRoute.{output}?steps={dep};[{steps};]{arr}&lg={lg}&db={db}&dist={dist}&time={time}&favMotorways={favMotorways}&avoidBorders={avoidBorders}&avoidTolls={avoidTolls}&avoidCCZ={avoidCCZ}&avoidORC={avoidORC}&nb={nb}&veht={veht}&itit={itit}&c[i]={c[i]}&authkey={authkey}&charset={charset}&ie={ie}&callback={callback}&signature={signature}

Format de sortie

xml, json

Comptabilisation

Une recherche de POIs = une requête facturée (quel que soit le nombre de résultats)

Versions du service

VersionDescription
1.0 Ajouté à l'API REST

 

Paramètres d'entrée

NomObligatoire?TypeDescriptionDéfaut
db oui string Identifiant unique de la base de données (fourni par ViaMichelin) N/A
lg oui string Code langue (fra, deu, spa, ita, eng, ces, dan, nld, fin, int, nor, pol, por, swe) N/A
steps oui (1=xy | 2=poiid | 3=locid):('e'=étape classique | 'p'=point de passage):( lon:lat |db:poiid | locid) Liste des étapes. Chaque étape est structurée et constituée de 3 informations: son mode de spécification de l'étape, le type d'étape, ses informations descriptives.
Les étapes sonts séparées par ';'
N/A
dist non positive integer Rayon de recherche autour de l'itinéraire en mètres (de 0 à 200,000). 10,000
time non positive integer Temps maximal pour atteindre les POI depuis de l'itinéraire en secondes (de 60 à 7,200). 600
favMotorways non bool Spécifie si le calcul doit favoriser les autoroutes. false
avoidBorders non bool Spécifie si le calcul doit éviter les passages de frontières. false
avoidTolls non bool Spécifie si le calcul doit éviter les péages. false
avoidCCZ non bool Spécifie si le calcul doit éviter zones payantes (Congestion Charge Zones). false
avoidORC non bool Spécifie si le calcul doit éviter les zones non routières comme les ferrys ou le ferroutage (Off-Road Connections). false
nb non positive integer Le nombre maximum de POI attendus (de 1 à 100). 20
veht non 0:Voiture | 1:Camion Type de véhicule utilisé pour le calcul d'itinéraire. Voiture
itit non 0:Conseillé par Michelin | 1:Plus rapide | 2:Plus court Type d'itinéraire à calculer.
Conseillé: favorise la sécurité, la simplicité et minimise les risques d'erreur de parcours.
Plus rapide prend le moins de temps pour se rendre à: sa destination. Cet itinéraire favorise les grands axes, notamment les autoroutes.
Plus court pour lequel la distance pour se rendre à son point de destination est la plus courte, tout en restant sur des routes praticables. Cet itinéraire est souvent très long en terme de durée..
Conseillé
c[i] non integer Critères de restriction de la recherche sur les valeurs de la métadonnée numérique [i]. Ce paramètre peut être multivalué. La sémantique du critère est propre à chaque base de POI.
Par exemple si l'on souhaite filtrer le critère 1 sur la valeur 1 et le critère 2 sur les valeurs 1 ou 2, on ecrira ...&c1=1&c2=1;2&....
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

  • Le nombre de POI retournés par une requête nb est techniquement plafonné à 100.
  • Le nombre de POI retourné avec la pagination est techniquement plafonné à 2000.
  • La disponibilité du calcul d'itinéraire est variable d'un pays à l'autre. ViaMichelin améliore continuellement cette couverture.
  • Le nombre d'étapes est techniquement plafonné à 8 en incluant les points de départ et d'arrivée.
  • Le rayon spatial de recherche dist est compris entre 100m et 200km.
  • Le rayon temporel de recherche time est techniquement plafonné à aux itinéraires routiers de 7200s (2h).

 

Exemples de requêtes

 

Structure de la réponse

  • La structure est de type poiList 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