IGN

Géoservices IGN

Bibliothèque d'accès aux ressources du Géoportail

Dernière mise à jour : 18 Juillet 2017

Table des matières

Généralités

La bibliothèque d’accès aux ressources de la plateforme Géoportail est une bibliothèque de fonctions javascript permettant d’accéder aux ressources délivrées par les services web du Géoportail.

Elle permet plus particulièrement d’effectuer les opérations suivantes utilisant les données de l’IGN :

Mise en oeuvre

Vous pouvez récupérer la bibliothèque d’accès soit en la téléchargeant directement, soit en utilisant le gestionnaire de dépendances javascript NPM.

Téléchargement direct

Vous pouvez récupérer ici la version compilée et autonome de la bibliothèque d’accès : GpServices.js, dans la partie “Downloads”.

Récupération avec NPM

La bibliothèque d’accès est aussi disponible dans les dépôts NPM.

Prérequis : NodeJS et npm installés.

npm install geoportal-access-lib

Intégration dans une page web

Intégrez la bibliothèque d’accès dans votre page WEB classiquement à l’aide d’une balise script.

<script src="chemin/vers/GpServices.js"></script>

Utilisation

Le chargement de la bibliothèque d’accès vous donne accès au namespace Gp.Services à partir duquel vous pouvez utiliser les différentes fonctions proposées.

Géocoder des adresses, toponymes et parcelles cadastrales

La fonction Gp.Services.geocode permet d’utiliser le service de géocodage de la plateforme Géoportail pour obtenir la position d’un toponyme, d’une adresse ou d’une parcelle cadastrale. Elle prend en paramètres :

Gp.Services.geocode({
    apiKey : "22726iz9m8ficsgf2hmiicpd", // clef d'accès à la plateforme
    location : "tour eiffel",            // localisant à géocoder
    filterOptions : {
        type : ["PositionOfInterest"]    // type de localisant
    },
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.GeocodeResponse
        ...
    }

});

Exemple d’utilisation jsFiddle

Obtenir des suggestions d’adresses ou de toponymes à partir de textes incomplets

La fonction Gp.Services.autoComplete permet d’utiliser le service d’autocomplétion de la plateforme Géoportail pour obtenir des suggestions de loclalisants (toponyme ou adresse) à partir d’un texte incomplet. Elle prend en paramètres :

Gp.Services.autoComplete({
    apiKey : "22726iz9m8ficsgf2hmiicpd", // clef d'accès à la plateforme
    text : "23 rue des et",              // texte à compléter
    filterOptions : {
        type : ["StreetAddress"]         // type de texte
    },
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.AutoCompleteResponse
        ...
    }

});

Exemple d’utilisation jsFiddle

Obtenir des localisants (toponymes, adresses, parcelles cadastrales) proches d’une position donnée (géocodage inverse)

La fonction Gp.Services.reverseGeocode permet d’utiliser le service de géocodage inverse de la plateforme Géoportail pour trouver des toponymes, adresses ou parcelles cadastrales proches d’une position donnée. Elle prend en paramètres :

Gp.Services.reverseGeocode({
    apiKey : "22726iz9m8ficsgf2hmiicpd", // clef d'accès à la plateforme
    position : {                         // position de recherche
      x: 2.29,
      y: 48.85
    },
    filterOptions : {
        type : ["PositionOfInterest"]    // type de localisant
    },
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.ReverseGeocodeResponse
        ...
    }

});

Exemple d’utilisation jsFiddle

Obtenir des altitudes en un ou plusieurs points ou calculer des profils altimétriques

La fonction Gp.Services.getAltitude() permet d’utiliser le service d’altimétrie de la plateforme Géoportail pour obtenir les altitudes de une ou plusieurs positions données ou calculer un profil altimétrique le long d’une liste de positions. Elle prend en paramètres :

Gp.Services.getAltitude({
    apiKey : "22726iz9m8ficsgf2hmiicpd", // clef d'accès à la plateforme
    positions : [                        // positions pour le calcul alti
        { lon: 2.29, lat: 48.85 },      
        { lon: 2.3, lat: 48.9 },
        { lon: 2.4, lat: 49 }
    ],
    sampling : 50,                      // nombre de points pour le profil
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.AltiResponse
        ...
    }
});

Exemple d’utilisation jsFiddle

Calculer un itinéraire piéton ou routier

La fonction Gp.Services.route() permet d’utiliser le service de calcul d’itinéraires de la plateforme Géoportail. Elle prend en paramètres :

Gp.Services.route({
    apiKey : "jhyvi0fgmnuxvfv0zjzorvdn", // clef d'accès à la plateforme
    startPoint : { x: 2, lat: 45},       // point de départ
    viaPoints : [                        // points intermédiaires
        { x: 3, y: 46 },      
        { x: 3.5, y: 46 }
    ],
    endPoint : { x: 4, y: 47},          // point d'arrivée
    graph : "Voiture",                 // grapĥe utilisé
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.RouteResponse
        ...
    }
});

Exemple d’utilisation jsFiddle

Calculer des isochrones / isodistances autour d’un point

La fonction Gp.Services.isoCurve() permet d’utiliser le service de calcul d’isochrones / isodistances de la plateforme Géoportail. Elle prend en paramètres :

Gp.Services.isoCurve({
    apiKey : "jhyvi0fgmnuxvfv0zjzorvdn", // clef d'accès à la plateforme
    position : { x: 2, lat: 45},       // point de référence
    method : "time",                   // méthode de calcul (isochrone)
    time : 1000,                       // limite de temps (isochrone)
    graph : "Pieton",                 // grapĥe utilisé
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.IsoCurveResponse
        ...
    }
});

Exemple d’utilisation jsFiddle

Obtenir des informations relatives à un contrat d’accès au Géoportail

La fonction Gp.Services.getConfig() permet de consulter, via le service d’autoconfiguration de la plateforme Géoportail, les ressources disponibles pour une clef d’accès à la plateforme et d’avoir les paramètres permettant leur utilisation. Elle prend en paramètres :

Gp.Services.getConfig({
    apiKey : "jhyvi0fgmnuxvfv0zjzorvdn", // clef d'accès à la plateforme
    onSuccess : function (result) {
        // exploitation des resultats : "result" est de type Gp.Services.GetConfigResponse
        ...
    }
});

Exemple d’utilisation jsFiddle