Documentation

Le guide d’utilisation d’ArcheoBase, pas à pas, avec ses vidéos.

API REST

API REST ArcheoBase (v1)

L'API REST d'ArcheoBase permet de lire les données de votre module Fouille (Entry) au format GeoJSON (RFC 7946) ou Esri JSON (format natif des API ArcGIS REST), pour une utilisation dans des systèmes externes tels qu'un SIG / ArcGIS.

URL de base

https://<domaine-archeobase-que-vous-utilisez>/api/v1

Authentification

Chaque requête doit contenir votre clé d'API dans l'en-tête Authorization :

Authorization: ApiKey <votre-clé>

Vous créez et révoquez les clés depuis le panneau Compte > API (droit administrateur requis). La clé n'est affichée qu'une seule fois à la création ; conservez-la en lieu sûr.

Portées

Chaque clé porte une ou plusieurs portées. Les points d'accès géoréférencés nécessitent la portée entry:geo.

Points d'accès

GET /api/v1/fields — liste les champs disponibles d'un type de formulaire.

  • id_subtype (requis) : identifiant du sous-type (photo = -1, dessin = -2, intervention = -10, site = -11). Vous trouvez l'id_subtype dans la fenêtre de configuration du formulaire concerné, à côté de son titre.
  • lang : fr, de, it ou en (fr par défaut).

GET /api/v1/geodata — géométries et attributs au format GeoJSON (FeatureCollection) ou Esri JSON, selon le paramètre f.

  • id_subtype (requis).
  • id_intervention : limiter à une intervention.
  • since : ISO 8601 UTC, uniquement les enregistrements modifiés après cette date.
  • fields : clés de champs à retourner, séparées par des virgules.
  • crs : code EPSG cible (4326 / WGS84 par défaut).
  • lang : fr, de, it ou en.
  • f : format de sortie — geojson (RFC 7946, par défaut) ou json (Esri JSON, format natif des API ArcGIS REST).
  • deleted : true pour récupérer les éléments supprimés depuis since (synchronisation des suppressions). Par défaut, seuls les éléments actifs sont retournés.

Synchronisation nocturne recommandée : récupérer d'abord les créations/modifications avec since, puis les suppressions avec since + deleted=true, appliquer les deux dans ArcGIS, puis mémoriser la nouvelle date.

Exemple

curl -H "Authorization: ApiKey <votre-clé>" \
  "https://<domaine-archeobase-que-vous-utilisez>/api/v1/geodata?id_subtype=123&crs=2056"