VIAMICHELIN REST API


Poi

Description

Access to a static point of interest(POI) resource providing its unique identifier (database id, POI id).

URL

http://apir.viamichelin.com/apir/1/poi.{output}/{db:poiid}/{lg}?authkey={authkey}&charset={charset}&ie={ie}&callback={callback}&signature={signature}

Format

xml, json

Billing

Access to a POI = Charged request (whetever the number of results)

Changelog

VersionDescription
1.0 Added to REST API

 

Input settings

NameMandatory?Data typeDescriptionDefault
db yes string Database unique identifier (given by ViaMichelin) N/A
poiid yes string POI unique identifier in the database N/A
lg yes string Language code (fra, deu, spa, ita, eng, ces, dan, nld, fin, int, nor, pol, por, swe) N/A
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

  • Database unique identifier is given by ViaMichelin, whatever the kind of POI (client or provided by ViaMichelin as Green Guide or Hotels). Client POI can get an id chosen by the client (see import procedure in OnlineTool).

 

Request samples

 

Response structure

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