VIAMICHELIN REST API


POI

Description

Accès à une ressource de type point d'intérêt (POI) par son identifiant unique formé par le couple (id base de données, id POI).

URL

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

Format de sortie

xml, json

Comptabilisation

Accès à un POI = 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
poiid oui string Identifiant unique du POI dans la base N/A
lg oui string Code langue (Code sur 3 caractères) N/A
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

  • L'identifiant unique de base de données est fourni par ViaMichelin, qu'il s'agisse d'une base de POI client, ou de POI mis à disposition par ViaMichelin (hôtels, Guide Vert,...). Dans le cas de POI client, les poiid peuvent-être déterminés par le client (au moment de l'import dans l'On-Line Manager)

 

Exemples de requêtes

 

Structure de la réponse

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