Geoportal Resources Access API Reference

Tutorial: optimize-getconfig

optimize-getconfig

Optimisez votre configuration d'accès à la plateforme géoportail

Pour utiliser les ressources du Géoportail, vous devez utiliser une ou plusieurs clefs d'accès gratuites qui répondent à vos besoins et qui peuvent être obtenues sur le site geoservices.ign.fr.

Vous pouvez accélerer votre application géoportail en récupérant la configuration associée à vos clefs d'accès géoportail.

Voici comment faire.

1. Récupérer le fichier d'autoconfiguration

Sélectionnez le nombre de clefs d'accès que vous souhaitez utiliser dans votre application géoportail.

Pour chaque clé, remplissez le champ correspondant avec son nom. Si vous voulez que les services géoportail soient requêtés en https par défaut, cliquez sur la case "accès https".

Cliquez sur le bouton "Récupérer le fichier de configuration".

accès https

Une fois chargé, sauvegardez le fichier "autoconf.json" (ou "autoconf-https.json") sur votre plateforme.

2. Configurez les fonctions géoportail pour utiliser ce fichier

Que ce soit avec la bibliothèque d'accès aux services Géoportail, les extensions Géoportail ou le SDK Géoportail, vous pouvez utiliser ce fichier pour configurer votre application.

Avec la bibliothèque d'accès aux services Géoportail

Utilisez le chemin vers votre fichier d'autoconfiguration comme une valeur du paramètre serverUrl de la fonction Gp.Services.getConfig() (à la place du paramètre apiKey) :

the Gp.Services.getConfig({
    ...
    serverUrl : "path/to/autoconf.json",
    callbackSuffix : "",
    ...
}) ;

Avec les extensions Géoportail

Utilisez le chemin vers votre fichier d'autoconfiguration dans l'attribut data-url du tag script qui permet de charger les extensions Géoportail (à la place de l'attribut dataKey) :

<script type="text/javascript" src="path/to/GpPluginLeaflet.js" data-url="path/to/autoconf.json"></script>
<!-- or -->
<script type="text/javascript" src="path/to/GpPluginOpenLayers.js" data-url="path/to/autoconf.json"></script>

Avec le SDK Géoportail

Utilisez le chemin vers votre fichier d'autoconfiguration comme une valeur du paramètre configUrl de l'objet Gp.MapOptions utilisé dans la fonction Gp.Map.load() (à la place du paramètre apiKey) :

Gp.Map.load(
    "mapDiv",    
    {
        ...
        configUrl : "path/to/autoconf.json",
        ...
    }
) ;