From c0c9aebf002fe9f2baccdd35b6f01734b4b2e60c Mon Sep 17 00:00:00 2001 From: elias couppe Date: Tue, 18 Jan 2022 16:22:27 +0100 Subject: [PATCH 1/9] docs(autoconf): refactor page optimize-getconfig --- doc/tutorials/optimize-getconfig-rework-fr.md | 175 ++++++++++++++++++ doc/tutorials/optimize-getconfig-rework.md | 174 +++++++++++++++++ 2 files changed, 349 insertions(+) create mode 100644 doc/tutorials/optimize-getconfig-rework-fr.md create mode 100644 doc/tutorials/optimize-getconfig-rework.md diff --git a/doc/tutorials/optimize-getconfig-rework-fr.md b/doc/tutorials/optimize-getconfig-rework-fr.md new file mode 100644 index 00000000..e3e2cbbb --- /dev/null +++ b/doc/tutorials/optimize-getconfig-rework-fr.md @@ -0,0 +1,175 @@ +# 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](https://geoservices.ign.fr/services-web). + +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](https://github.com/ignf/geoportal-access-lib), [les extensions Géoportail](https://github.com/IGNF/geoportal-extensions) ou [le SDK Géoportail](http://ignf.github.io/evolution-apigeoportail/sdk/presentation.html), 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()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~getConfig) (à la place du paramètre **apiKey**) : + +``` javascript +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**) : + +``` html + + + +``` + + +#### 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**) : + +``` javascript +Gp.Map.load( + "mapDiv", + { + ... + configUrl : "path/to/autoconf.json", + ... + } +) ; +``` diff --git a/doc/tutorials/optimize-getconfig-rework.md b/doc/tutorials/optimize-getconfig-rework.md new file mode 100644 index 00000000..10f77ef9 --- /dev/null +++ b/doc/tutorials/optimize-getconfig-rework.md @@ -0,0 +1,174 @@ +# Optimize your geoportal access configuration + +To use Geoportal resources, you need one or several access keys which can be obtained on the [geoservices.ign.fr web site](https://geoservices.ign.fr/services-web). + +You can speed up your geoportal application by caching your the configuration associated to your geoportal access key(s) on your server. + +Here is how you can do. + + +### 1. Get the configuration file + +Fill the input text below with your geoportal access key ; if you want Geoportal Services to be accessed by default in https, check the "https access" check box. + +Click the "Get Config File" button. + +
+
+ + +
+
+

+ + +

+
+
+ https access + +

+
+
+ + + + + +When prompted, save the file "autoconf.json" (or "autoconf-https.json") on your platform. + + +### 2. Configure geoportal functions to use that file + +Be it [Geoportal access lib](https://github.com/ignf/geoportal-access-lib), [Geoportal extensions](https://github.com/IGNF/geoportal-extensions) or [Geoportal SDK](http://ignf.github.io/evolution-apigeoportail/sdk/presentation.html), you can use that file to configure your application : + + +#### With Geoportal access lib + +Use it as a value of the **serverUrl** param of the [Gp.Services.getConfig()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~getConfig) function (instead of the **apiKey** param) : + +``` javascript +the Gp.Services.getConfig({ + ... + serverUrl : "path/to/autoconf.json", + callbackSuffix : "", + ... +}) ; +``` + + +#### With Geoportal extensions + +Use it with the **data-url** attribute of the script tag used to load the Geoportal extension (instead of the **data-key** attribute) : + +``` html + + + +``` + + +#### With Geoportal SDK + +Use it as a value of the **configUrl** param of the Gp.MapOptions object used in the Gp.Map.load() function (instead of the **apiKey** param) : + +``` javascript +Gp.Map.load( + "mapDiv", + { + ... + configUrl : "path/to/autoconf.json", + ... + } +) ; +``` From b94229761a7f5f6fb9a46c72bd00df5255cad330 Mon Sep 17 00:00:00 2001 From: elias couppe Date: Wed, 19 Jan 2022 10:12:10 +0100 Subject: [PATCH 2/9] =?UTF-8?q?update(changelog):=20met=20=C3=A0=20jour=20?= =?UTF-8?q?le=20changelog?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- DRAFT_CHANGELOG.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/DRAFT_CHANGELOG.md b/DRAFT_CHANGELOG.md index d7732332..1196ae2d 100644 --- a/DRAFT_CHANGELOG.md +++ b/DRAFT_CHANGELOG.md @@ -1,6 +1,6 @@ -# Bibliothèque d'accès aux services Géoportail, version 3.0.5 +# Bibliothèque d'accès aux services Géoportail, version 3.0.6 -**03/12/2021 : 3.0.5** +**xx/xx/2022 : 3.0.6** > release of geoportal access library @@ -10,10 +10,10 @@ * [Added] - - En options en entrée de l'autoconf, il y a possibilité désormais de passer une liste de clés sous forme de string. ex. "key1,key2,key3" (#77) - * [Changed] + - refactorisation de la page de documentation pour récupérer l'autoconf en local (#78) + * [Removed] * [Fixed] From 6b46da9b3b63c1c3bced64bbc55d5f6adeb5dee1 Mon Sep 17 00:00:00 2001 From: elias couppe Date: Wed, 19 Jan 2022 10:15:24 +0100 Subject: [PATCH 3/9] update: remplacement de l'ancien fichier tutoriel --- ...ework.md => optimize-getconfig-english.md} | 0 doc/tutorials/optimize-getconfig-rework-fr.md | 175 ----------------- doc/tutorials/optimize-getconfig.md | 184 ++++++++++++------ 3 files changed, 123 insertions(+), 236 deletions(-) rename doc/tutorials/{optimize-getconfig-rework.md => optimize-getconfig-english.md} (100%) delete mode 100644 doc/tutorials/optimize-getconfig-rework-fr.md diff --git a/doc/tutorials/optimize-getconfig-rework.md b/doc/tutorials/optimize-getconfig-english.md similarity index 100% rename from doc/tutorials/optimize-getconfig-rework.md rename to doc/tutorials/optimize-getconfig-english.md diff --git a/doc/tutorials/optimize-getconfig-rework-fr.md b/doc/tutorials/optimize-getconfig-rework-fr.md deleted file mode 100644 index e3e2cbbb..00000000 --- a/doc/tutorials/optimize-getconfig-rework-fr.md +++ /dev/null @@ -1,175 +0,0 @@ -# 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](https://geoservices.ign.fr/services-web). - -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](https://github.com/ignf/geoportal-access-lib), [les extensions Géoportail](https://github.com/IGNF/geoportal-extensions) ou [le SDK Géoportail](http://ignf.github.io/evolution-apigeoportail/sdk/presentation.html), 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()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~getConfig) (à la place du paramètre **apiKey**) : - -``` javascript -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**) : - -``` html - - - -``` - - -#### 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**) : - -``` javascript -Gp.Map.load( - "mapDiv", - { - ... - configUrl : "path/to/autoconf.json", - ... - } -) ; -``` diff --git a/doc/tutorials/optimize-getconfig.md b/doc/tutorials/optimize-getconfig.md index 733f5dac..e3e2cbbb 100644 --- a/doc/tutorials/optimize-getconfig.md +++ b/doc/tutorials/optimize-getconfig.md @@ -1,80 +1,142 @@ -# Optimize your geoportal access configuration +# Optimisez votre configuration d'accès à la plateforme géoportail -To use Geoportal resources, you need an access key which can be obtained on the [professionels.ign.fr web site](http://professionnels.ign.fr/ign/contrats). +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](https://geoservices.ign.fr/services-web). -You can speed up your geoportal application by caching your the configuration associated to your geoportal access key on your server. +Vous pouvez accélerer votre application géoportail en récupérant la configuration associée à vos clefs d'accès géoportail. -Here is how you can do. +Voici comment faire. -### 1. Get the configuration file +### 1. Récupérer le fichier d'autoconfiguration -Fill the input text below with your geoportal access key ; if you want Geoportal Services to be accessed by default in https, check the "https access" check box. +Sélectionnez le nombre de clefs d'accès que vous souhaitez utiliser dans votre application géoportail. -Click the "Get Config File" button. +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". -

- -https access -

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

+ + +

+
+
+ accès https + +

+
+
+ -When prompted, save the file "autoconf.json" (or "autoconf-https.json") on your platform. +Une fois chargé, sauvegardez le fichier "autoconf.json" (ou "autoconf-https.json") sur votre plateforme. -### 2. Configure geoportal functions to use that file +### 2. Configurez les fonctions géoportail pour utiliser ce fichier -Be it [Geoportal access lib](https://github.com/ignf/geoportal-access-lib), [Geoportal extensions](https://github.com/IGNF/geoportal-extensions) or [Geoportal SDK](http://ignf.github.io/evolution-apigeoportail/sdk/presentation.html), you can use that file to configure your application : +Que ce soit avec [la bibliothèque d'accès aux services Géoportail](https://github.com/ignf/geoportal-access-lib), [les extensions Géoportail](https://github.com/IGNF/geoportal-extensions) ou [le SDK Géoportail](http://ignf.github.io/evolution-apigeoportail/sdk/presentation.html), vous pouvez utiliser ce fichier pour configurer votre application. -#### With Geoportal access lib +#### Avec la bibliothèque d'accès aux services Géoportail -Use it as a value of the **serverUrl** param of the [Gp.Services.getConfig()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~getConfig) function (instead of the **apiKey** param) : +Utilisez le chemin vers votre fichier d'autoconfiguration comme une valeur du paramètre **serverUrl** de la fonction [Gp.Services.getConfig()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~getConfig) (à la place du paramètre **apiKey**) : ``` javascript the Gp.Services.getConfig({ @@ -86,9 +148,9 @@ the Gp.Services.getConfig({ ``` -#### With Geoportal extensions +#### Avec les extensions Géoportail -Use it with the **data-url** attribute of the script tag used to load the Geoportal extension (instead of the **data-key** attribute) : +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**) : ``` html @@ -97,9 +159,9 @@ Use it with the **data-url** attribute of the script tag used to load the Geopor ``` -#### With Geoportal SDK +#### Avec le SDK Géoportail -Use it as a value of the **configUrl** param of the Gp.MapOptions object used in the Gp.Map.load() function (instead of the **apiKey** param) : +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**) : ``` javascript Gp.Map.load( From 9be6b58566f2a8d1cca11a3cb977735da3bf5b20 Mon Sep 17 00:00:00 2001 From: elias couppe Date: Thu, 20 Jan 2022 18:30:17 +0100 Subject: [PATCH 4/9] update(doc): urls vers geoservices + jsdoc getconfig --- src/Services/Services.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Services/Services.js b/src/Services/Services.js index 76235f73..b2379f02 100644 --- a/src/Services/Services.js +++ b/src/Services/Services.js @@ -20,7 +20,7 @@ var Services = { * * @method getConfig * @param {Object} options - Options for function call. - * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link http://professionnels.ign.fr/ign/contrats}. + * @param {String} options.apiKey - Access key(s) ("," as separator, no spaces) to Geoportal platform, obtained [here]{@link http://professionnels.ign.fr/ign/contrats}. * @param {Function} options.onSuccess - Callback function for getting successful service response. Takes a {@link Gp.Services.GetConfigResponse} object as a parameter except if "rawResponse" parameter is set to true : a String will be returned. * @param {Function} [options.onFailure] - Callback function for handling unsuccessful service responses (timeOut, missing rights, ...). Takes a {@link Gp.Error} object as parameter. * @param {Number} [options.timeOut=0] - Number of milliseconds above which a timeOut response will be returned with onFailure callback (see above). Default value is 0 which means timeOut will not be handled. From 45e46a292f657e6ccb60294f31f77d3d3deaf03e Mon Sep 17 00:00:00 2001 From: elias couppe Date: Mon, 24 Jan 2022 19:14:34 +0100 Subject: [PATCH 5/9] doc(README): mention de geoservices.ign.fr... ...au lieu de professionnel.ign.fr --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 58c56684..bdcf779a 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,7 @@ Le chargement de la bibliothèque d'accès vous donne accès au namespace [Gp.Se La fonction [Gp.Services.geocode](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~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 : -* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [professionnels.ign.fr](http://professionnels.ign.fr/ign/contrats) ayant les droits sur les ressources de recherche OpenLS du Géoportail. +* une (ou des) **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources de recherche OpenLS du Géoportail. * le **localisant** dont on veut obtenir les coordonnées ; @@ -140,7 +140,7 @@ La fonction [Gp.Services.geocode](http://ignf.github.io/geoportal-access-lib/lat ``` javascript Gp.Services.geocode({ - apiKey : "22726iz9m8ficsgf2hmiicpd", // clef d'accès à la plateforme + apiKey : "calcul", // clef d'accès à la plateforme location : "tour eiffel", // localisant à géocoder filterOptions : { type : ["PositionOfInterest"] // type de localisant @@ -162,7 +162,7 @@ Gp.Services.geocode({ La fonction [Gp.Services.autoComplete](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~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 : -* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [professionnels.ign.fr](http://professionnels.ign.fr/ign/contrats) ayant les droits sur les ressources de recherche OpenLS du Géoportail. +* une (ou des) **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources de recherche OpenLS du Géoportail. * le **texte** pour lequel on souhaite obtenir des suggestions @@ -175,7 +175,7 @@ La fonction [Gp.Services.autoComplete](http://ignf.github.io/geoportal-access-li ``` javascript Gp.Services.autoComplete({ - apiKey : "22726iz9m8ficsgf2hmiicpd", // clef d'accès à la plateforme + apiKey : "calcul", // clef d'accès à la plateforme text : "23 rue des et", // texte à compléter filterOptions : { type : ["StreetAddress"] // type de texte @@ -197,7 +197,7 @@ Gp.Services.autoComplete({ La fonction [Gp.Services.reverseGeocode](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~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 : -* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [professionnels.ign.fr](http://professionnels.ign.fr/ign/contrats) ayant les droits sur les ressources de recherche OpenLS du Géoportail. +* une (ou des) **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources de recherche OpenLS du Géoportail. * une **position** donnée @@ -210,7 +210,7 @@ La fonction [Gp.Services.reverseGeocode](http://ignf.github.io/geoportal-access- ``` javascript Gp.Services.reverseGeocode({ - apiKey : "22726iz9m8ficsgf2hmiicpd", // clef d'accès à la plateforme + apiKey : "calcul", // clef d'accès à la plateforme position : { // position de recherche x: 2.29, y: 48.85 @@ -235,7 +235,7 @@ Gp.Services.reverseGeocode({ La fonction [Gp.Services.getAltitude()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~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 : -* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [professionnels.ign.fr](http://professionnels.ign.fr/ign/contrats) ayant les droits sur les ressources altimétriques du Géoportail. +* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources altimétriques du Géoportail. * une **liste de positions** données @@ -248,7 +248,7 @@ La fonction [Gp.Services.getAltitude()](http://ignf.github.io/geoportal-access-l ``` javascript Gp.Services.getAltitude({ - apiKey : "22726iz9m8ficsgf2hmiicpd", // clef d'accès à la plateforme + apiKey : "carte", // clef d'accès à la plateforme positions : [ // positions pour le calcul alti { lon: 2.29, lat: 48.85 }, { lon: 2.3, lat: 48.9 }, @@ -271,7 +271,7 @@ Gp.Services.getAltitude({ La fonction [Gp.Services.route()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~route) permet d'utiliser le service de calcul d'itinéraires de la plateforme Géoportail. Elle prend en paramètres : -* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [professionnels.ign.fr](http://professionnels.ign.fr/ign/contrats) ayant les droits sur les ressources utilisés par le calcul d'itinéraire du Géoportail : graphe routier ou piéton. +* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources utilisés par le calcul d'itinéraire du Géoportail : graphe routier ou piéton. * des **points de départ, d'arrivée** et éventuellement **intermédiaires**. @@ -284,7 +284,7 @@ La fonction [Gp.Services.route()](http://ignf.github.io/geoportal-access-lib/lat ``` javascript Gp.Services.route({ - apiKey : "jhyvi0fgmnuxvfv0zjzorvdn", // clef d'accès à la plateforme + apiKey : "carte", // clef d'accès à la plateforme startPoint : { x: 2, y: 45}, // point de départ viaPoints : [ // points intermédiaires { x: 3, y: 46 }, @@ -308,7 +308,7 @@ Gp.Services.route({ La fonction [Gp.Services.isoCurve()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~isoCurve) permet d'utiliser le service de calcul d'isochrones / isodistances de la plateforme Géoportail. Elle prend en paramètres : -* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [professionnels.ign.fr](http://professionnels.ign.fr/ign/contrats) ayant les droits sur les ressources utilisés par le calcul d'isochrones / isodistances du Géoportail : graphe routier ou piéton. +* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) ayant les droits sur les ressources utilisés par le calcul d'isochrones / isodistances du Géoportail : graphe routier ou piéton. * une **position de référence** (départ ou arrivée) pour le calcul. @@ -325,7 +325,7 @@ La fonction [Gp.Services.isoCurve()](http://ignf.github.io/geoportal-access-lib/ ``` javascript Gp.Services.isoCurve({ - apiKey : "jhyvi0fgmnuxvfv0zjzorvdn", // clef d'accès à la plateforme + apiKey : "carte", // clef d'accès à la plateforme position : { x: 2, y: 45}, // point de référence method : "time", // méthode de calcul (isochrone) time : 1000, // limite de temps (isochrone) @@ -346,7 +346,7 @@ Gp.Services.isoCurve({ La fonction [Gp.Services.getConfig()](http://ignf.github.io/geoportal-access-lib/latest/jsdoc/module-Services.html#~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 : -* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [professionnels.ign.fr](http://professionnels.ign.fr/ign/contrats) dont on veut consulter les droits. +* une **clef d'accès à la plateforme Géoportail** obtenue sur le site [geoservices.ign.fr](https://geoservices.ign.fr/services-web) dont on veut consulter les droits. * d'autres paramètres éventuels à passer au service... @@ -355,7 +355,7 @@ La fonction [Gp.Services.getConfig()](http://ignf.github.io/geoportal-access-lib ``` javascript Gp.Services.getConfig({ - apiKey : "jhyvi0fgmnuxvfv0zjzorvdn", // clef d'accès à la plateforme + apiKey : "carte", // clef d'accès à la plateforme onSuccess : function (result) { // exploitation des resultats : "result" est de type Gp.Services.GetConfigResponse ... From ecd9b4235882c117815500fa0d17c49bc3b8aa18 Mon Sep 17 00:00:00 2001 From: elias couppe Date: Mon, 24 Jan 2022 19:31:25 +0100 Subject: [PATCH 6/9] =?UTF-8?q?doc(update):=20met=20=C3=A0=20jour=20la=20j?= =?UTF-8?q?sdoc=20avec=20geoservices=20et=20cla=20cl=C3=A9=20"calcul"?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/Services/DefaultUrlService.js | 20 ++++++++++---------- src/Services/Services.js | 16 ++++++++-------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/src/Services/DefaultUrlService.js b/src/Services/DefaultUrlService.js index b60b2614..77337f9e 100644 --- a/src/Services/DefaultUrlService.js +++ b/src/Services/DefaultUrlService.js @@ -15,25 +15,25 @@ // Example : // -// DefaultUrlService.Alti.url('efe4r54tj4uy5i78o7545eaz7e87a')[elevation-json] -// output {String} -> http://wxs.ign.fr/efe4r54tj4uy5i78o7545eaz7e87a/alti/rest/elevation.json +// DefaultUrlService.Alti.url('alti')[elevation-json] +// output {String} -> http://wxs.ign.fr/calcul/alti/rest/elevation.json // -// DefaultUrlService.Alti.url('efe4r54tj4uy5i78o7545eaz7e87a') +// DefaultUrlService.Alti.url('calcul') // output {Object|String} -// -> http://wxs.ign.fr/efe4r54tj4uy5i78o7545eaz7e87a/alti/rest/elevation.json -// -> http://wxs.ign.fr/efe4r54tj4uy5i78o7545eaz7e87a/alti/rest/elevation.xml -// -> http://wxs.ign.fr/efe4r54tj4uy5i78o7545eaz7e87a/alti/rest/elevationLine.json -// -> http://wxs.ign.fr/efe4r54tj4uy5i78o7545eaz7e87a/alti/rest/elevationLine.xml -// -> http://wxs.ign.fr/efe4r54tj4uy5i78o7545eaz7e87a/alti/wps +// -> http://wxs.ign.fr/calcul/alti/rest/elevation.json +// -> http://wxs.ign.fr/calcul/alti/rest/elevation.xml +// -> http://wxs.ign.fr/calcul/alti/rest/elevationLine.json +// -> http://wxs.ign.fr/calcul/alti/rest/elevationLine.xml +// -> http://wxs.ign.fr/calcul/alti/wps // // ssl by default. // // Force to not do ssl : // DefaultUrlService.ssl = false; // -// DefaultUrlService.AutoComplete.url('efe4r54tj4uy5i78o7545eaz7e87a') +// DefaultUrlService.AutoComplete.url('calcul') // output {Object|String} -// -> https://wxs.ign.fr/efe4r54tj4uy5i78o7545eaz7e87a/ols/apis/completion +// -> https://wxs.ign.fr/calcul/ols/apis/completion // constantes internes var HOSTNAME = "wxs.ign.fr"; diff --git a/src/Services/Services.js b/src/Services/Services.js index 76235f73..f4b2a748 100644 --- a/src/Services/Services.js +++ b/src/Services/Services.js @@ -20,7 +20,7 @@ var Services = { * * @method getConfig * @param {Object} options - Options for function call. - * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link http://professionnels.ign.fr/ign/contrats}. + * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link https://geoservices.ign.fr/services-web}. * @param {Function} options.onSuccess - Callback function for getting successful service response. Takes a {@link Gp.Services.GetConfigResponse} object as a parameter except if "rawResponse" parameter is set to true : a String will be returned. * @param {Function} [options.onFailure] - Callback function for handling unsuccessful service responses (timeOut, missing rights, ...). Takes a {@link Gp.Error} object as parameter. * @param {Number} [options.timeOut=0] - Number of milliseconds above which a timeOut response will be returned with onFailure callback (see above). Default value is 0 which means timeOut will not be handled. @@ -47,7 +47,7 @@ var Services = { * * @method getAltitude * @param {Object} options - Options for function call. - * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link http://professionnels.ign.fr/ign/contrats}. + * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link https://geoservices.ign.fr/services-web}. * @param {Array.} options.positions - Array of positions ({lon:float, lat:float}) expressed in CRS:84 coordinates system, where to get elevations. 50 positions maximum may be given. 2 positions minimum are required if you use the options.sampling parameter. * @param {Number} [options.sampling] - Number of points to use (between 2 and 5000) in order to compute an elevation path. The points given with the options.positions parameter are used to fix the planimetric path along which the elevations will be computed.
* If not used, only elevations of these positions will be returned. @@ -76,7 +76,7 @@ var Services = { * * @example * Gp.Services.geocode ({ - * apiKey : "jhyvi0fgmnuxvfv0zjzorvdn", + * apiKey : "carte", * location : "73 avenue de Paris, Saint-Mandé", * // traitement des resultats * onSuccess : function (result) { @@ -87,7 +87,7 @@ var Services = { * * @method geocode * @param {Object} options - Options for function call. - * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link http://professionnels.ign.fr/ign/contrats}. + * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link https://geoservices.ign.fr/services-web}. * @param {String|Object} options.location - Geographic identifier to locate. May be provided as a single String or a structured Object for an address search. In this last case, the following properties are availaibles. * @param {Number} [options.location.number] - Street number. * @param {String} [options.location.street] - Street name. @@ -135,7 +135,7 @@ var Services = { * * @method reverseGeocode * @param {Object} options - Options for function call. - * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link http://professionnels.ign.fr/ign/contrats}. + * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link https://geoservices.ign.fr/services-web}. * @param {Gp.Point} options.position - Reference position where to search geographical identifiers. Its coordinates are expressed in the coordinates system given with options.srs parameter. (default is CRS:84, that means position.x is the longitude and position.y the latitude) * @param {Object} [options.filterOptions] - Additional filters to apply to search. The following properties may be given. * @param {Array.} [options.filterOptions.type] - Geographical identifier types to search. Values currently availables are : "PositionOfInterest" for place names, "StreetAddress" for address search, "CadastralParcel" for Cadastral parcels search. Default is "StreetAddress". @@ -167,7 +167,7 @@ var Services = { * * @method autoComplete * @param {Object} options - Options for function call. - * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link http://professionnels.ign.fr/ign/contrats}. + * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link https://geoservices.ign.fr/services-web}. * @param {String} options.text - Text input to complete. * @param {Array.} [options.filterOptions.type = "StreetAddress"] - Suggestion types to provide : address ("StreetAddress") and/or place name ("PositionOfInterest"). * @param {Array.} [options.filterOptions.territory] - Places where to limit the search of suggestions : "METROPOLE" (Corsica and metropolitan France), "DOMTOM" (French overseas departments and territories), or an INSEE code of a department. No limitation by default. For instance : ['METROPOLE', '31'] @@ -195,7 +195,7 @@ var Services = { * @method route * @param {Object} options - Options for function call. * @param {String} options.resource - Resource used to compute the route. Available values are in the GetCapabilities. - * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link http://professionnels.ign.fr/ign/contrats}. + * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link https://geoservices.ign.fr/services-web}. * @param {String} [options.routePreference = "fastest"] - Indicates the way to compute the route : "fastest" (time optimisation) or "shortest" (distance optimisation). Available values are in the GetCapabilities. * @param {Gp.Point} options.startPoint - Start point of the route. Expressed in CRS:84 coordinates system (startPoint.x corresponds to longitude, startPoint.y corresponds to latitude). Available bbox are in the GetCapabilities. * @param {Gp.Point} options.endPoint - End point of the route. Expressed in CRS:84 coordinates system (endPoint.x corresponds to longitude, endPoint.y corresponds to latitude). Available bbox are in the GetCapabilities. @@ -231,7 +231,7 @@ var Services = { * * @method isoCurve * @param {Object} options - Options for function call. - * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link http://professionnels.ign.fr/ign/contrats}. + * @param {String} options.apiKey - Access key to Geoportal platform, obtained [here]{@link https://geoservices.ign.fr/services-web}. * @param {Gp.Point} options.position - Start or Arrival (options.reverse===true) Point for the computing. Expressed in CRS:84 coordinates system (position.x corresponds to longitude, position.y corresponds to latitude). * @param {String} [options.graph = "Voiture"] - User profile to use to compute the isoCurve : "Voiture" (using a vehicule) or "Pieton" (pedestrian). Has an influence on the kind of roads to use and the average speed. * @param {Array.} [options.exclusions] - Indicates if route has to avoid some features ("toll", "bridge" or "tunnel"). From 2e4730d6215f8378e9f576f15e391354257cde50 Mon Sep 17 00:00:00 2001 From: elias couppe Date: Mon, 24 Jan 2022 19:32:05 +0100 Subject: [PATCH 7/9] =?UTF-8?q?samples(update):=20met=20=C3=A0=20jour=20le?= =?UTF-8?q?s=20exemples=20avec=20la=20cl=C3=A9=20"calcul"?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- samples-src/config.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples-src/config.json b/samples-src/config.json index 009aca2c..f26ca67d 100644 --- a/samples-src/config.json +++ b/samples-src/config.json @@ -2,5 +2,5 @@ "baseurl" : "../..", "bundle" : "GpServices", "resources" : "../resources", - "apikey" : "jhyvi0fgmnuxvfv0zjzorvdn" + "apikey" : "calcul" } From 027a3d71d999c12f6f6f7f588d53ab3c782bbcec Mon Sep 17 00:00:00 2001 From: elias couppe Date: Tue, 25 Jan 2022 11:10:02 +0100 Subject: [PATCH 8/9] =?UTF-8?q?update(changelog):=20met=20=C3=A0=20jour=20?= =?UTF-8?q?le=20changelog?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- DRAFT_CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/DRAFT_CHANGELOG.md b/DRAFT_CHANGELOG.md index 1196ae2d..90431b73 100644 --- a/DRAFT_CHANGELOG.md +++ b/DRAFT_CHANGELOG.md @@ -6,6 +6,8 @@ ## Summary +Mise à jour de la documentation pour utilisation de clefs génériques multiples + ## Changelog * [Added] @@ -13,6 +15,7 @@ * [Changed] - refactorisation de la page de documentation pour récupérer l'autoconf en local (#78) + - mise à jour du readme et de la jsdoc (#79 et #80) * [Removed] From 13dd7a507ab6c3c6c78328040d0af50dad86469f Mon Sep 17 00:00:00 2001 From: elias couppe Date: Tue, 25 Jan 2022 16:55:39 +0100 Subject: [PATCH 9/9] release 3.0.6 --- DRAFT_CHANGELOG.md | 2 +- package.json | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DRAFT_CHANGELOG.md b/DRAFT_CHANGELOG.md index 90431b73..37e111ce 100644 --- a/DRAFT_CHANGELOG.md +++ b/DRAFT_CHANGELOG.md @@ -1,6 +1,6 @@ # Bibliothèque d'accès aux services Géoportail, version 3.0.6 -**xx/xx/2022 : 3.0.6** +**25/01/2022 : 3.0.6** > release of geoportal access library diff --git a/package.json b/package.json index bdb89439..840412a4 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "geoportal-access-lib", - "version": "3.0.5", - "date": "03/12/2021", + "version": "3.0.6", + "date": "25/01/2022", "description": "French Geoportal resources access library", "module": "src/Gp.js", "main": "dist/GpServices-src.js",