Utilisation de l'API REST du Géoportail
L'API REST dans le Géoportail
L'API REST du Géoportail permet à chaque enregistrement de métadonnées dans le catalogue du géoportail d'avoir une URL unique attribuée accessible par le Web. Le catalogue du géoportail peut également être demandé via des URL utilisant la syntaxe REST. L'accès aux documents de métadonnées individuels via leurs URL REST, ou aux groupes de documents qui correspondent aux critères spécifiques via une URL de recherche mise en forme par REST, offre une fonctionnalité puissante pour la recherche, l'affichage et le partage des enregistrements. Par exemple, vous pouvez envoyer l'URL à un document de métadonnées ou une recherche à des collègues, et ils peuvent accéder à cette ressource sans devoir aller sur le géoportail et mener leur propre recherche. L'intégration des URL dans les autres pages Web, ou le Système de gestion de contenu de votre organisation, propose aux utilisateurs des liens rapides vers les ressources sans qu'ils aient besoin de mener leur propre recherche. En outre, l'API REST permet une intégration facile aux applications externes, comme décrit ci-dessous.
Pour voir l'URL REST d'un enregistrement de métadonnées individuel, cliquez sur le lien 'Détails' de l'enregistrement dans une liste de résultats de recherche et faites défiler vers le bas de la page Détails. L'URL sera mise en forme de manière identique à ce qui suit, avec un GUID unique qui remplace celui indiqué ici en italique.
/geoportal/rest/document?f=html&id=%7BF6B6CCA6-9013-4018-9FFE-5F8163E27FBD%7D
Pour voir les résultats mis en forme par REST pour une recherche spécifique, faites défiler jusqu'en bas de la page de résultats de recherche du géoportail après avoir effectué une recherche avec vos critères d'intérêt. Vous verrez les liens affichant la recherche en format GEORSS, ATOM, HTML, FRAGMENT, KML ou JSON REST. Chaque format REST est décrit dans la table ci-dessous, avec un exemple de la manière dont ce format peut être utilisé dans une application externe.
Format REST | Description | Application externe |
|---|---|---|
GEORSS | Affiche les résultats en format GEORSS, ce qui permet également aux utilisateurs de s'abonner à un flux RSS pour les enregistrements correspondant aux critères de recherche | Lecteurs RSS comme Microsoft® Outlook 2007, Microsoft® Internet Explorer et Mozilla Firefox |
ATOM | L'affichage génère un format ATOM, une autre norme pour récupérer les flux de syndication qui permet également aux utilisateurs de s'abonner aux mises à jour | Lecteurs RSS comme Microsoft® Outlook 2007, Microsoft® Internet Explorer et Mozilla Firefox |
HTML | Met en forme les résultats sous forme de document HTML complet | Systèmes de gestion de contenu et Wikis comme Microsoft® SharePoint, Joomla!™ et JSPWiki |
FRAGMENT | Met en forme les résultats sous forme de fragment du document HTML, sans les balises <html>,<head>,<title> ou <body> | Systèmes de gestion de contenu et Wikis comme Microsoft® SharePoint, Joomla!™ et JSPWiki |
KML | Met en forme les résultats sous forme de KML, permettant d'afficher les résultats de recherche dans les applications de cartographie Web | Applications de cartographie comme Google™ Maps, Google™ Earth, Microsoft® Virtual Earth |
JSON | Met en forme les résultats sous forme de 'pretty' JSON | Applications de personnalisation comme les widgets de développement pour Microsoft® Silverlight |
L'API REST permet également aux utilisateurs de rechercher sur le Géoportail directement à partir de leur navigateur via la fonctionnalité OpenSearch. Ce sont des possibilités sans limite concernant la manière dont votre catalogue du Géoportail peut être intégré dans d'autres applications, offrant à votre catalogue de métadonnées plus d'importance et d'exposition.