documentation

Le service d'autoconfiguration n'est plus appelé par les API. Pour le remplacer, nous générons quotidiennement, à partir des getCapabilities des services WMS et WMTS, des fichiers de configuration en JSON appelables par les API JavaScript Géoportail. Il y a un fichier par clé générique.

L'avantage de ce nouveau processus (en plus de s'adapter à l’arrêt à venir du service d'autoconfiguration) est que les fichiers de configuration JSON sont directement au format attendu par les API : il n'y a plus besoin de parser une réponse XML pour en extraire les informations utiles puis pour les introduire dans une structure adéquate.

Par exemple, en renseignant "cartes" au paramètre apiKey, c'est le fichier cartesConfig.json qui sera chargé et directement utilisé par les API.

Concrètement, quels changements pour vous ?

• Si vous renseigniez une ou plusieurs clés au paramètre apiKey, vous n’avez rien besoin de modifier pour le moment, c’est simplement la manière dont l’API va récupérer les informations qui change.
• Si vous utilisiez un fichier d’autoconfiguration «local», généré avant la publication de ces versions, vous pouvez en générer un nouveau (cf. avec un fichier de configuration personnel), ou utiliser le paramètre apiKey (cf. avec une ou plusieurs clés d'accès géoportail.). Pour l’appeler, il faut utiliser le paramètre «customConfigFile».

Pour plus de détail consultez les exemples ci-dessous.

Exemple d’utilisation de la bibliothèque d'accès :

Code javascript

var options = {  
   apiKey : "cartes", 
   onSuccess : function (response) { 
      print(response); 
   }, 
   onFailure : function (error) { 
      print(error.message); 
   } 
}; 
Gp.Services.getConfig(options);

Avant

Le fichier d'autoconfiguration de la clé "cartes" au format XML était récupéré depuis https://wxs.ign.fr/autoconf/cartes, parsé, puis utilisé par les API JavaScript Géoportail.

Maintenant

Le fichier de configuration de la clé "cartes" est récupéré depuis https://raw.githubusercontent.com/IG...tesConfig.json puis directement utilisé par les API JavaScript Géoportail.

À noter que le multiKeys est toujours géré, c'est à dire qu'il est possible de renseigner plusieurs clés dans le paramètre apiKey.

Exemple d’utilisation des Extensions Géoportail pour OpenLayers

Code html

<script src="chemin/vers/GpPluginOpenLayers.js" data-key="ortho,cartes,administratif">

Code javascript

Gp.Services.getConfig({
    apiKey: "cartes,ortho,administratif",
    timeOut: 20000,
    onSuccess: createMap
});

Avant

Un fichier d'autoconfiguration filtré pour chaque clé "cartes", "ortho" et "administratif" étaient récupérés au format XML, parsés, et utilisés par les API JavaScript Géoportail.

Maintenant

Les fichiers de configuration "cartesConfig.json", "orthoConfig.json" et "administratifConfig.json" sont récupérés et directement utilisés par les API JavaScript Géoportail.

Il est également possible de générer son propre fichier de configuration à partir d'une ou plusieurs clés, génériques ou personnelles. L'utilitaire est temporairement disponible ici : https://geoportal-configuration.onrender.com. Le paramètre permettant ensuite de charger sa configuration personnelle à partir du fichier local généré s'appelle désormais «customConfigFile», auquel on associera le chemin vers le fichier de configuration json à charger.

Exemple d’utilisation des Extensions Géoportail pour Leaflet

Avant

 Code html

<script src="chemin/vers/GpPluginLeaflet.js" data-url="chemin/vers/mon/autoconf/AutoConf.js"></script>

Code javascript

Gp.Services.getConfig({
    serverUrl : "chemin/vers/mon/autoconf/AutoConf.js",
    timeOut : 20000,
    onSuccess : createMap
});

Maintenant

Code html

<script src="chemin/vers/GpPluginLeaflet.js" data-url="chemin/vers/ma/config/customConfig.json"></script>

Code javascript

Gp.Services.getConfig({
    customConfigFile: "chemin/vers/ma/config/customConfig.json",
    timeOut: 20000,
    onSuccess: createMap
});

Exemple d’utilisation du SDK

Avant

 Code javascript

var map = Gp.Map.load("viewerDiv", {
            configUrl : "../resources/autoconf.js",
            viewMode : "3d",
            layersOptions : {
                "ORTHOIMAGERY.ORTHOPHOTOS" : {
                },
                "ELEVATION.ELEVATIONGRIDCOVERAGE" : {
                    type : "elevation"
                }
            },
            center : {
                x : 2.357,
                y : 48.83
            },
            controlsOptions : {
                layerSwitcher : {
                    maximised : true
                }
            }
        });

Maintenant

Code javascript

var map = Gp.Map.load("viewerDiv", {
            customConfigFile : "chemin/vers/ma/config/customConfig.json",
            viewMode : "3d",
            layersOptions : {
                "ORTHOIMAGERY.ORTHOPHOTOS" : {
                },
                "ELEVATION.ELEVATIONGRIDCOVERAGE" : {
                    type : "elevation"
                }
            },
            center : {
                x : 2.357,
                y : 48.83
            },
            controlsOptions : {
                layerSwitcher : {
                    maximised : true
                }
            }
        });