wiki:Geonol/API_REST

Version 11 (modified by http://cbenz.myopenid.com/, 7 years ago) (diff)

--

API REST

L'API REST de Geonol permet de rechercher des POI dans la base de données.

La requête est faite par l'URL : http://annuaire.comarquage.fr/rest/poi.kml?query_string, où query_string est remplacé par les paramètres documentés ci-dessous.

La réponse est au format KML : http://code.google.com/intl/fr-FR/apis/kml/documentation/.

Paramètres de la requête

  • page (int) : numéro de la page. Commence à 1.
  • q (str) : recherche sur les différents champs de l'organisme : nom, adresse, etc. (fulltext search). Cette recherche est « approximative » : elle porte sur les radicaux des mots.
  • tag (str) : type de l'organisme ou mot-clé associé.
  • where (str) : nom du territoire auquel appartient l'organisme.
  • bbox (str) : définit un rectangle (bounding-box) dans lequel rechercher les organismes. La chaîne doit se composer de 4 nombres flottants séparés par une virgule. Les décimales sont séparées par un point. Les deux premiers nombres définissent le coin en bas à gauche du rectangle, et les deux derniers le coin en haut à droite.

Tous les paramètres sont optionnels et peuvent être combinés.

Réponse

Les champs suivants du format KML sont utilisés :

  • name : nom du document
  • ExtendedData? : contient les informations relatives à la pagination
  • Placemark : définit les organismes
    • name : nom de l'organisme
    • address : adresse de l'organisme, formatée en chaîne de caractères d'une seule ligne, sans balise HTML
    • Point : coordonnées géographiques de l'organisme
    • Style : contient le code HTML de l'info-bulle associée à l'organisme, au format utilisé par Google Maps pour rendre la couche KML. Contient une adresse au format hcard (http://microformats.org/wiki/hcard), et le cas échéant l'URL vers la page source de l'organisme, dans l'annuaire original où il a été indexé (lien profond).

Exemples de requêtes

Exemple de réponse KML

cf Geonol/API_REST/KMLResponseExample

Intégration dans Google Maps