L'API du Géoportail a pour but de permettre la superposition des couches métiers utilisateurs avec les référentiels pour tous types d'applications.
L'API Web 2D du Géoportail est la déclinaison Web de l'API Géoportail permettant aux applications Web de superposer les données utilisateurs avec les référentiels.
Les informations contenues dans la présente documentation nécessitent à minima la connaissance d'un certain nombre de technologies liées à l'information géographique et de l'information. Parmi ces technologies, on trouvera :
Les technologies listées ci-dessus ne sont pas les seules dans le domaine de la géomatique...
La présente documentation et les exemples de code associés se rapportent à la version 1.0beta4 de l'API.
L'API Web 2D permet d'intégrer en quelques lignes une carte Géoportail sur n'importe quelle page HTML.
Réalisée en JavaScript et basée sur la bibliothèque OpenLayers (logiciel libre sous licence BSD), elle surcharge les librairies de ce dernier pour apporter de nouvelles fonctionnalités.
Les livraisons bêta sont construites sur différentes versions d'OpenLayers :
| Date de livraison | Version | Fonctionnalités |
| 6 mai 2009 | 1.0beta4 | Séparation entre le visualisateur et la carte en préparation de la version 1.0 : il est nécessaire de modifier les pages pour passer à cette version comme indiqué dans les évolutions. Introduction des API minimum, standard et étendue. Ajout du support de la recherche par OpenLS (Location Utility Service). Expérimental. |
| 4 novembre 2008 | 1.0beta3 | OpenLayers 2.7, support préliminaire en écriture du format Geoconcept export. Retrait de Prototype et Script.aculo.us. Nouvelle barre d'édition et nouveaux composants pour le gestionnaire de couches. Documentation basée sur NaturalDocs. Ouverture au zoom mondial. |
| 1er juillet 2008 | 1.0beta2 | OpenLayers 2.6, plus de fonctionnalités au support du format GPX. |
| 4 juin 2008 | 1.0beta1 | Corrections de quelques boggues, quelques fonctionnalités OpenLayers 2.6 et support préliminaire du format GPX. |
| 28 avril 2008 | 1.0beta | OpenLayers 2.5 avec le support des projections. |
Pour de plus amples informations, se rapporter aux évolutions.
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.
La figure suivante schématise le fonctionnement de l'API 2D :

Le schéma ci-dessus décrit trois parties principales :
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).
Ces entrepôts sont accessibles par des services (Web Map Service, Web Feature Service, ...) ou par des transferts HTTP classiques (Keyhole Markup Language, ...). Un autre composant important réside côté service : le service de gestion de droits en information géographique (connu aussi sous les vocables GeoDRM ou GeoRM). Ce service gère la licence en provenance du client.
L'API est chargée ici. Pour le client Web 2D, son architecture interne est la suivante :
Cette bibliothèque met en oeuvre la charte graphique de l'API et se connecte avec le service GeoDRM.
Les services du Géoportail (WMS-C, WMS, WFS) peuvent être connectés à des applications SIG. Pour cela, il faut mettre en oeuvre un connecteur à notre GeoRM. Pour plus d'information, il faut nous contacter à 'contact dot api at ign dot fr'.