Documentation

The ArcheoBase user guide, step by step, with its videos.

REST API

ArcheoBase REST API (v1)

The ArcheoBase REST API lets you read your Entry-module data as GeoJSON (RFC 7946) or Esri JSON (the ArcGIS REST APIs' native format), for use in external systems such as GIS / ArcGIS.

Base URL

https://<archeobase-domain-you-use>/api/v1

Authentication

Every request must carry your API key in the Authorization header:

Authorization: ApiKey <your-key>

You create and revoke keys from the Account > API panel (administrator right required). The key is shown only once at creation; store it safely.

Scopes

Each key carries one or more scopes. Georeferenced endpoints require the entry:geo scope.

Endpoints

GET /api/v1/fields — lists the available fields of a form type.

  • id_subtype (required): the subtype id (photo = -1, drawing = -2, intervention = -10, site = -11). You can find the id_subtype in the configuration window of the relevant form, next to its title.
  • lang: fr, de, it or en (default fr).

GET /api/v1/geodata — geometries and attributes as GeoJSON (FeatureCollection) or Esri JSON, per the f parameter.

  • id_subtype (required).
  • id_intervention: restrict to a single intervention.
  • since: ISO 8601 UTC, only rows modified after this date.
  • fields: comma-separated field keys to return.
  • crs: target EPSG code (default 4326 / WGS84).
  • lang: fr, de, it or en.
  • f: output format — geojson (RFC 7946, default) or json (Esri JSON, the ArcGIS REST APIs' native format).
  • deleted: true to fetch the features deleted since since (deletion sync). By default only active features are returned.

Recommended nightly sync: first fetch creations/modifications with since, then deletions with since + deleted=true, apply both in ArcGIS, then store the new date.

Example

curl -H "Authorization: ApiKey <your-key>" \
  "https://<archeobase-domain-you-use>/api/v1/geodata?id_subtype=123&crs=2056"