Dokumentation

Das Benutzerhandbuch von ArcheoBase, Schritt für Schritt, mit seinen Videos.

REST-API

ArcheoBase REST-API (v1)

Die ArcheoBase REST-API ermöglicht das Auslesen der Daten Ihres Moduls Erfassung (Entry) im GeoJSON-Format (RFC 7946) oder Esri JSON (natives Format der ArcGIS REST-APIs) zur Verwendung in externen Systemen wie GIS / ArcGIS.

Basis-URL

https://<archeobase-domain-die-sie-verwenden>/api/v1

Authentifizierung

Jede Anfrage muss Ihren API-Schlüssel im Authorization-Header enthalten:

Authorization: ApiKey <ihr-schlüssel>

Schlüssel erstellen und widerrufen Sie im Bereich Konto > API (Administratorrecht erforderlich). Der Schlüssel wird nur einmal bei der Erstellung angezeigt; bewahren Sie ihn sicher auf.

Bereiche

Jeder Schlüssel besitzt einen oder mehrere Bereiche. Georeferenzierte Endpunkte erfordern den Bereich entry:geo.

Endpunkte

GET /api/v1/fields — listet die verfügbaren Felder eines Formulartyps auf.

  • id_subtype (erforderlich): Subtyp-ID (Foto = -1, Zeichnung = -2, Intervention = -10, Fundstelle = -11). Die id_subtype finden Sie im Konfigurationsfenster des betreffenden Formulars, neben dessen Titel.
  • lang: fr, de, it oder en (Standard fr).

GET /api/v1/geodata — Geometrien und Attribute im GeoJSON- (FeatureCollection) oder Esri-JSON-Format, je nach Parameter f.

  • id_subtype (erforderlich).
  • id_intervention: auf eine Intervention beschränken.
  • since: ISO 8601 UTC, nur nach diesem Datum geänderte Datensätze.
  • fields: kommagetrennte Feldschlüssel, die zurückgegeben werden sollen.
  • crs: Ziel-EPSG-Code (Standard 4326 / WGS84).
  • lang: fr, de, it oder en.
  • f: Ausgabeformat — geojson (RFC 7946, Standard) oder json (Esri JSON, natives Format der ArcGIS REST-APIs).
  • deleted: true, um die seit since gelöschten Elemente abzurufen (Synchronisation von Löschungen). Standardmäßig werden nur aktive Elemente zurückgegeben.

Empfohlene nächtliche Synchronisation: zuerst Erstellungen/Änderungen mit since abrufen, dann Löschungen mit since + deleted=true, beide in ArcGIS anwenden und anschließend das neue Datum speichern.

Beispiel

curl -H "Authorization: ApiKey <ihr-schlüssel>" \
  "https://<archeobase-domain-die-sie-verwenden>/api/v1/geodata?id_subtype=123&crs=2056"