doc api qgis

nobohan 2021-10-21 09:22:32 +02:00
parent 78e7799f1d
commit f0ee33677a
6 changed files with 63 additions and 4 deletions

@ -1,7 +1,18 @@
Il existe un projet QGIS qui permet de lire les données de la base de données.
## Principe
Procédure avec screenshot pour ajouter les couches
Il est possible d'utiliser QGIS pour accéder directement aux données de la base de données BiomMap. Une table d'une base de données peut être ajouté à un projet QGIS en ajoutant une couche PostGIS, comme indiqué dans la figure suivante.
note sur l'accès à distance d'une db
![Connexion à une base de données PostGIS avec QGIS](img/qgis-postgis-connection.png)
test accès API en geojson
Il faut rentrer les informations d'authentification (nom d'utilisateur + mot de passe) pour se connecter à la base de données. Attention, cela ne peut fonctionner que si la base de données de GeoNature-citizen/Biommap a été exposée à l'extérieur, contacter l'administrateur pour le savoir.
Ensuite, toutes les tables sont affichées dans le navigateur (browser) de données de QGIS, comme indiqué dans la figure suivante. Les tables sont organisées selon plusieurs schémas (càd des groupes de tables): gnc_core, gnc_sites, ... Les tables des sites avec leur information sont dans le schéma "gnc_sites". Comme les sites peuvent être de 3 types de géométrie, QGIS sépare la table des sites (t_sites) en plusieurs couches. Les tables sans géométries ne sont pas listées ici, mais elles peuvent l'être si on a coché "Also list table with no geometry" dans la fenêtre de connexion PostGIS (voir la première figure).
![Liste des couches PostGIS](img/qgis-postgis.png)
## Accès
Il existe un projet QGIS qui permet de lire les données de la base de données et qui a dû être partagé avec la documentation. Ce projet permet non seulement de visualiser et traiter les informations, mais aussi de les éditer (modification, suppression). Attention aux manipulations car QGIS agira dans ce projet directement sur la base de données de Biommap!
Attention, ce projet ne peut fonctionner que si l'accès à la base de donnée a été ouvert à l'extérieur et si les informations de connection (nom d'utilisateur + mot de passe) sont connus.

48
Utilisation-API.md Normal file

@ -0,0 +1,48 @@
L'application GeoNature-citizen expose les données des programmes, des observations et des sites au travers de points d'API pour le fonctionnement de l'application.
Ces points d'accès peuvent aussi être utilisés pour avoir, sans authentification requise, un accès direct aux données.
## Détails de points d'API les plus utiles
### 1) Point d'API de tous les programmes
- url: `api/programs`
- exemple: <https://biomap.champs-libres.be/api/programs>
Expose tous les programmes définis, mais sans les données (observations ou sites) de ces programmes. Peut-être utile pour retrouver l'id d'un programme afin de voir le détail du programme (point 2) ou ses observations ou sites (point 3).
### 2) Point d'API d'un programme
- url: `api/programs/{id}`
- exemple: <https://biomap.champs-libres.be/api/programs/1>
Expose le détail d'un programme, comme dans le point d'API précédent, sans les données (observations ou sites) de ce programme, mais avec la géométrie de la zone géographique du programme (par exemple la commune).
### 3) Point d'API des sites du programme
- url: `api/sites/programs/{id}`
- exemple: <https://biomap.champs-libres.be/api/sites/programs/1>
Expose tous les sites encodés d'un programme. Donne un geojson valide qui peut être utilisé dans QGIS.
### 4) Point d'API du détail d'un site
- url: `api/sites/{id}`
- exemple: <https://biomap.champs-libres.be/api/sites/1>
Expose le détail d'un site. Comprend les photos (noms des fichiers uniquement) et tous les rapports de visites qui contiennent les informations rentrées par les utilisateurs dans le formulaire des visites.
## Utilisation de ces points d'API avec QGIS
Les données des sites peuvent être directement intégré dans un projet QGIS. Ajouter une couche vectorielle au projet en tant que fichier en spécifiant l'adresse du point d'API des sites d'un programme, par exemple https://biomap.champs-libres.be/api/sites/programs/1. La figure suivante montre une capture d'écran de cet ajout.
![utilisation d'un point d'API dans QGIS](img/qgis-api.png)
Ces points d'API de données par programme sont en lecture seule. Un projet QGIS peut donc être partagé avec ces points d'API sans risquer que l'utilisateur modifie les données. Pour utiliser QGIS en ayant la possibilité d'éditer les données, voir le point "Interaction QGIS - base de données".
Un projet QGIS avec ces points d'API a été préparé. Une capture d'écran de ce projet est dans la figure suivante:
![Projet QGIS "lecture biommap](img/qgis-lecture-projet.png)

BIN
img/qgis-api.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

BIN
img/qgis-lecture-projet.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

BIN
img/qgis-postgis.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB