Documentation technique de l'API Géoportail

  • FR
  • UK

Accueil / Documentation / Documentation technique

Avant propos

NB : Les informations qui suivent concernent les API Javascript v2 et Flash qui sont en cours de remplacement par de nouvelles versions décrites ici.

API Web 2D 
API Web 2D en Javascript 
API Web 2D en Flex 
API 3D

L'API du Géoportail a pour but de permettre la superposition des couches métiers utilisateurs avec les référentiels Géoportail pour différents types d'applications cartographiques.

Le schéma ci-dessus décrit son fonctionnement:

architecture

On distingue trois parties principales :

  • les composants côté serveur :

    Les entrepôts de données sont gérés ici. Ils peuvent être sous un gestionnaire de base de données (postgreSQL, mySQL, Oracle, Informix, ArcSDE, etc ...) ou directement sur le système de fichiers sous forme de répertoires de fichiers (cache, arborescences).

  • les services :

    Ces entrepôts sont accessibles par des services (Web Map Service, Web Feature Service, ...) ou par des transferts HTTP classiques (Keyhole Markup Language, ...).

    L'accès à ces services est protégé par le contrôle des droits d'accès: chaque requête aux serveurs nécessite une clef d'accès.

  • les composants côté client :

    L'API cliente est chargée ici.

API Web 2D

Disponible dans deux langages de programmation (JavaScript et Flex), elle permet d'intégrer les référentiels Géoportail dans un site Web via un client cartographique.

L'utilisation de l'API en Flex n'est cependant pas encouragée du fait de l'obsolescence de la technologie flash.

API Web 2D en Javascript

Réalisée en JavaScript et basée sur la bibliothèque OpenLayers (logiciel libre sous licence BSD), elle surcharge les librairies de cette dernière pour apporter de nouvelles fonctionnalités comme des contrôleurs, des visualiseurs,...

Toutes ces fonctionnalités sont accessibles d'une manière très simple grâce à la classe Geoportal.Map, qui encapsule toute la puissance de l'API derrière quelques méthodes.

Les développeurs peuvent également utiliser l'intégralité des fonctions OpenLayers.

Les livraisons sont construites sur différentes versions d'OpenLayers.

Un exemple est donné .

API Web 2D en Flex

Réalisée en Flex et basée sur le projet open source OPENSCALES (licence LGPL v3), elle surcharge les librairies de ce dernier pour apporter de nouvelles fonctionnalités. Elle permet ainsi d'intégrer les données du Géoportail dans une application flash.

Un exemple est donné .

L'API Flash est dépréciée et n'est plus maintenue par l'IGN.

API 3D

Réalisée en javascript, l'API 3D permet d'intégrer dans une page web le globe virtuel VirtualGeo avec les données du Géoportail. Un exemple est donné .

L'API 3D est dépréciée et n'est plus maintenue par l'IGN.