Documentation de l'API Collaborative IGN

Cette API permet d'interagir avec les concepts de l'espace collaboratif de l'IGN :

  • les signalements
  • les structures (tables, colonnes) et contenus (features, transactions) des bases de données
  • les configurations : les communautés et leurs membres, les couches cartographiques

Généralités

Toutes les réponses et les corps de requête quand il y en a sont en JSON.

La racine de l'API est https://espacecollaboratif.ign.fr/gcms/api

L'authentification se fait toujours en HTTP Basic en soumettant username et password avec la requête.

Le concept de groupe dans les interfaces graphiques de l'espace collaboratif est celui de community dans l'API.

Les requêtes renvoyant des collections de résultats peuvent ne pas renvoyer l'intégralité des résultats. Dans ce cas le code de réponse n'est pas 200 mais 206 Partial content et la réponse contient un en-tête Content-Range : début-fin/nombre qui permet de savoir combien de résultats il y a au total et de requêter les pages suivantes.

Changelog

Migration depuis l'ancienne API de signalement

Il est vivement encouragé d'adapter les logiciels clients et de ne plus interroger les routes de l'ancienne API. Celles-ci continuent à être valides mais ne seront plus corrigées en cas de dysfonctionnement et seront supprimées à terme.

  • La route GET geoaut_get est remplacée par GET /users/me et l'appel à la description des communautés, couches... autant que nécessaire.
  • La route GET georems_get est remplacée par GET /reports
  • La route GET georem_get est remplacée par GET /reports/{report_id}
  • La route POST georem_post est remplacée par POST /reports
  • La route POST georep_post est remplacée par POST /reports/{report_id}/replies NB : La notion de profil actif n'intervient plus comme filtrage implicite dans la récupération des signalements. Pour filtrer les signalements (GET /reports) il faut préciser explicitement tous les critères de filtrage à chaque requête. Par rapport à l'ancienne API (GET georems_get), ceci permet de récupérer plus facilement en une seule fois des signalements liés à plusieurs groupes (communities). De ce fait, l'ancienne route switch_profile n'a pas de remplacement.

Documentation des routes