VIAMICHELIN REST API


Geocode1F

Description

Converts addresses into geographic coordinates (WGS84) and obtain an ordered list of places matching these geographical coordinates with the parameters provided. Address is entered on a single field (country, city, postcode, street).

URL

http://apir.viamichelin.com/apir/1/geocode1f.{output}?lg={lg}&query={query}&nb={nb}&authkey={authkey}&charset={charset}&ie={ie}&callback={callback}&signature={signature}

Format de sortie

xml, json

Billing

Geocoding of an address = charged request (whetever the number of results)

Changelog

VersionDescription
1.0 Added to REST API

 

Input settings

NameMandatory?Data typeDescriptionDefault
lg yes string Language code (fra, deu, spa, ita, eng, ces, dan, nld, fin, int, nor, pol, por, swe) N/A
country no string If not defined, the search is made around all the world.
If country and favcare both defined, country will have the priority.
Country ISO 3166-1 alpha-3 code.
empty
favc no string If defined, the search will favor the selected countries.
Country ISO 3166-1 alpha-3 code.
empty
query yes string Country, Zip code, City name and Address (with number) empty
nb no positive integer Maximal number of returned locations (from 1 to 50) 20
authkey yes string Authentication key. This could be a JS key, a token generated by the token function, or the client's id if request is signed (see signature parameter). N/A
signature no string Request signed with the HMAC-SHA1 method where client's password is the secret key. If request signed, authKey must be valued with client's id, and expires must also be valued. URL strings must be URL-encoded before signing. empty
expires no except if signature valued date Expiration GMT date in yyyy-MM-dd'T'HH:mm:ss.SSS`'Z format. vide
callback yes if json string Callback function name (applied only if output is json) empty
charset no string Response encoding charset 'ISO-8859-1'
ie no string Request encoding charset 'ISO-8859-1'

 

Constraints

  • Geocoding accuracy is dependant on geographic coverage that change from one country to another. ViaMichelin improves continuously this coverage.
  • Number of results cannot exceed 50.
  • returned locid have no meaning outside ViaMichelin services. They are not portable among other geodata suppliers. They should not be considered sustainable over time.

 

Request samples

 

Response structure

  • A structure of locationList open in new tab
  •  

Please note that unexplained data fields are intended for internal ViaMichelin use only. These can change at any moment and should not be considered for use. Their existence highlights the fact that ViaMichelin uses the same services and technical infrastructure internally as its business clients.

Retour haut de page