VIAMICHELIN REST API


Geocode4F

Description

Le géocodage est la fonction qui convertit une adresse postale en des coordonnées géographiques (au format WGS84). Elle retourne une liste de localisations ordonnées par corrélation décroissante avec les paramètres saisis.
L'adresse est saisie sur 4 champs distincts (pays, ville, code postal, adresse).

URL

http://apir.viamichelin.com/apir/1/geocode4f.{output}?country={country}&zip={zip}&city={city}&address={address}&nb={nb}&authkey={authkey}&charset={charset}&ie={ie}&callback={callback}&signature={signature}

Format de sortie

xml, json

Comptabilisation

Un géocodage = 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
country oui string Spécifie un pays comme périmètre géographique de la recherche.
Code ISO alpha 3 pays.
vide
zip oui sauf si city ou address définis string Critère de restriction de la recherche sur le code postal vide
city oui sauf si zip ou address définis string Critère de restriction de la recherche sur la ville vide
address oui sauf si zip ou city définis string Critère de restriction de la recherche sur l'adresse (rue, gare) vide
nb non positive integer Le nombre maximal de résultats que l'on souhaite (compris entre 1 et 50) 20
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

  • La précision de la réponse dépend de la qualité de la couverture géographique qui est variable d'un pays à l'autre. ViaMichelin améliore continuellement cette couverture.
  • Le nombre de résultats retournés est techniquement plafonné à 50.
  • Les locid> retournés (identifiants entre les balises <id>...</id>) n'ont de sens que pour les différents services ViaMichelin. Ils ne sont pas portables chez d'autres fournisseurs de géo-données. Ils ne doivent pas être considérés comme pérennes sur la durée.

 

Exemples de requêtes

 

Structure de la réponse

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