Faire appel à l'information géographique pour simplifier les démarches
Clone or download
Pull request Compare This branch is 61 commits ahead, 19 commits behind etalab:master.
Latest commit a9d11ab Aug 22, 2018

README.md

APICarto

Circle CI Coverage Status Dependency Status Join the chat at https://gitter.im/sgmap/apicarto

Prérequis

Pour faire fonctionner APICarto, vous avez besoin de :

  • Node.js v6+ (utilisation de nvm recommandée)
  • PostgreSQL v9.4+
  • PostGIS v2.1+
  • ogr2ogr v1.11+
  • wget (inclus dans la plupart des distributions Linux)

Sous Ubuntu 14.04 :

# Installer ogr2ogr
apt-get install gdal-bin

# Installer PostgreSQL et PostGIS
apt-get postgresql postgis postgresql-9.4-postgis-2.1

Sous Mac OS X :

# Installer ogr2ogr
brew install gdal

# Installer PostgreSQL et PostGIS
brew install postgresql postgis

Variables d'environnements

Configuration de la connexion postgresql

La connexion à la base postgresql est configurée à l'aide des variables d'environnement standard postgresql :

Variable Description
PGHOST Host du serveur postgresql
PGDATABASE Nom de la base de données
PGUSER Nom de l'utilisateur
PGPASSWORD Mot de passe de l'utilisateur

Configuration de la clé géoportail

Les modules faisant appel aux flux geoportail supportent un paramètre apikey en paramètre de requête. Il est toutefois possible de déployer un serveur APICARTO où les utilisateurs n'ont pas besoin de fournir ce paramètre :

Variable Description Valeur par défaut
GEOPORTAL_API_KEY Clé geoportail aucune
GEOPORTAL_REFERER Permet d'écraser le referer http://localhost

L'ordre de priorité dans l'utilisation des variables est le suivant :

  • Pour la clé d'API, on utilise d'abord apikey, puis la variable d'environnement GEOPORTAL_API_KEY
  • Pour le referer, si le paramètre apikey est utilisé, on utilise le referer de la requête. Sinon, on utilise GEOPORTAL_REFERER et en dernier recours la valeur par défaut.

Remarque : Vous n'êtes pas obligé de créer une clé protégée par referer, vous pouvez aussi spécifier une protection par IP (celui du serveur hébergeant APICARTO) ou par User-Agent ('apicarto')

Sources de données

Nom Description Source
bdparcellaire Base de données cadastrale http://professionnels.ign.fr/bdparcellaire
adminexpress Découpage administratif du territoire métropolitain et ultra-marin http://professionnels.ign.fr/adminexpress
osm-commune Découpage administratif issu de openstreetmap https://www.data.gouv.fr/fr/datasets/decoupage-administratif-communal-francais-issu-d-openstreetmap/#
inao-appellation Appellation viticoles INAO https://www.data.gouv.fr/fr/datasets/delimitation-parcellaire-des-aoc-viticoles-de-linao/#_
codes-postaux Codes postaux associés aux communes Voir https://github.com/etalab/codes-postaux#sources

Installation

Installation du package

npm install

Création de la base de données

La base qui contiendra les données locales doit être créée au prélable.

createdb "apicarto"
psql -d "apicarto" -c "CREATE EXTENSION postgis"

Chargement des données

PGDATABASE=apicarto npm run import

Clé Géoportail IGN

Certaines couches de données WFS utilisées par l'API sont en accès restreint (paramètre apikey). Veuillez contacter l'IGN via l'espace professionnel pour avoir accès à ces couches via une clé géoportail.

Lancer le service

npm start

Développement derrière un proxy

En cas de nécessité, utiliser les variables d'environnement standards.