Documentazione

La guida d’uso di ArcheoBase, passo dopo passo, con i suoi video.

API REST

API REST ArcheoBase (v1)

L'API REST di ArcheoBase consente di leggere i dati del tuo modulo Scavo (Entry) in formato GeoJSON (RFC 7946) o Esri JSON (formato nativo delle API ArcGIS REST), per l'uso in sistemi esterni come GIS / ArcGIS.

URL di base

https://<dominio-archeobase-che-utilizzi>/api/v1

Autenticazione

Ogni richiesta deve contenere la tua chiave API nell'intestazione Authorization:

Authorization: ApiKey <la-tua-chiave>

Le chiavi si creano e si revocano dal pannello Account > API (diritto di amministratore richiesto). La chiave viene mostrata una sola volta alla creazione; conservala in un luogo sicuro.

Ambiti

Ogni chiave possiede uno o più ambiti. Gli endpoint georeferenziati richiedono l'ambito entry:geo.

Endpoint

GET /api/v1/fields — elenca i campi disponibili di un tipo di modulo.

  • id_subtype (obbligatorio): identificativo del sottotipo (foto = -1, disegno = -2, intervento = -10, sito = -11). Trovi l'id_subtype nella finestra di configurazione del modulo interessato, accanto al suo titolo.
  • lang: fr, de, it o en (predefinito fr).

GET /api/v1/geodata — geometrie e attributi in formato GeoJSON (FeatureCollection) o Esri JSON, secondo il parametro f.

  • id_subtype (obbligatorio).
  • id_intervention: limitare a un intervento.
  • since: ISO 8601 UTC, solo i record modificati dopo questa data.
  • fields: chiavi dei campi da restituire, separate da virgole.
  • crs: codice EPSG di destinazione (predefinito 4326 / WGS84).
  • lang: fr, de, it o en.
  • f: formato di output — geojson (RFC 7946, predefinito) o json (Esri JSON, formato nativo delle API ArcGIS REST).
  • deleted: true per recuperare gli elementi eliminati dopo since (sincronizzazione delle eliminazioni). Per impostazione predefinita vengono restituiti solo gli elementi attivi.

Sincronizzazione notturna consigliata: recuperare prima creazioni/modifiche con since, poi le eliminazioni con since + deleted=true, applicare entrambe in ArcGIS e infine memorizzare la nuova data.

Esempio

curl -H "Authorization: ApiKey <la-tua-chiave>" \
  "https://<dominio-archeobase-che-utilizzi>/api/v1/geodata?id_subtype=123&crs=2056"