VIAMICHELIN REST API


FINDINPUTPOI

Description

Searches the closest dynamic POI from a specific place and returns a POI list sorted by ascending distance. Calculation is based on as the crow flies. POIs are given as parameters.

URL

http://apir.viamichelin.com/apir/1/FindInputPOI.{output}?inputpoi={id1;x1;y1[+id2;x2;y2[+idn;xn;yn]]}&center={lon;lat}&dist={dist}&nb={nb}&authkey={authkey}&charset={charset}&ie={ie}&callback={callback}&signature={signature}

Format

xml, json

Billing

A proximity search = Charged request (whetever the number of results)

Changelog

VersionDescription
1.0 Added to REST API

 

Input settings

NameMandatory?Data typeDescriptionDefault
center yes float:float Center of search as longitude:latitude exprimé in decimal degrees N/A
inputpoi yes string:float:float dynamique POI list (minimum 1 maximum 30) as Name:longitude:latitude. N/A
dist no positive integer Search radius in meters (from 0 to 200,000). 10000
nb no positive integer Number of returned POI (from 1 to 100). 20
time no positive integer Time limit to reach the POI in seconds (from 60 to 7200). 600
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

  • Spatial search radius dist has to be higher than 100m and lower than 200km.
  • The number of input poi cannot exceed 30.

 

Request samples

 

Response structure

  • A structure of poiList 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