API DigiLetClass

Accesso programmatico alle entità del Carteggio Canneti-Fiacchi.

Informazioni generali
Base URL
https://digiletclass.unibo.it/api/v1
Formato risposta
application/json
Autenticazione
nessuna
CORS
abilitato per tutti i domini
Licenza dati
CC BY 4.0

Paginazione

Tutti gli endpoint di lista restituiscono 25 risultati per pagina. Usa il parametro page per navigare.

Per scaricare tutti i risultati in un'unica risposta, senza paginazione, imposta per_page=all.

Struttura risposta
{
  "page": 1,
  "per_page": 25,
  "total": 1162,
  "total_pages": 47,
  "items": [ ... ]
}
Scaricare tutto (senza paginazione)
GET /api/v1/people?per_page=all

Persone
GET /api/v1/people

Lista paginata delle persone citate nel carteggio.

ParametroTipoDescrizione
searchstringRicerca sul nome
sexm | fFiltra per sesso
birth_fromintegerAnno di nascita minimo
birth_tointegerAnno di nascita massimo
pageintegerPagina (default: 1)
per_pageallSe all, restituisce tutti i risultati senza paginazione
Esempio richiesta
GET /api/v1/people?search=Canneti&sex=m
Risposta
{
  "page": 1,
  "per_page": 25,
  "total": 1,
  "total_pages": 1,
  "items": [ { "id": "DLCL_CF_PC0001", ... } ]
}
GET /api/v1/people/<id>

Dati di una singola persona per ID.

Esempio richiesta
GET /api/v1/people/DLCL_CF_PC0001
Risposta
{
  "id": "DLCL_CF_PC0001",
  "sameAs": "http://viaf.org/viaf/88842923",
  "sex": "m",
  "pers_names": [
    { "name": "Pietro Canneti",
      "lang": "it", "parts": [...] }
  ],
  "birth": "1659-11-21",
  "birth_place": "Cremona",
  "death": "1730-10-01",
  "death_place": "Faenza",
  "occupations": ["bibliotecario", "poeta"],
  "affiliations": ["Ordine dei Camaldolesi"],
  "idnos": [
    { "type": "VIAF", "value": "88842923" },
    { "type": "GND",  "value": "1057568929" }
  ],
  "note": null
}

Luoghi
GET /api/v1/places

Lista paginata dei luoghi.

ParametroTipoDescrizione
searchstringRicerca sul nome
typestringTipo (es. settlement)
countryISO 3166Nazione (es. IT)
pageintegerPagina (default: 1)
per_pageallSe all, restituisce tutti i risultati senza paginazione
Esempio richiesta
GET /api/v1/places?type=settlement&country=IT
Risposta
{
  "page": 1, "per_page": 25,
  "total": 111, "total_pages": 5,
  "items": [ { "id": "DLCL_CF_L0002", ... } ]
}
GET /api/v1/places/<id>

Dati di un singolo luogo per ID.

Esempio richiesta
GET /api/v1/places/DLCL_CF_L0002
Risposta
{
  "id": "DLCL_CF_L0002",
  "sameAs": "https://www.geonames.org/3169561/",
  "type": "settlement",
  "place_names": [{ "name": "Ravenna", "lang": "it" }],
  "location": {
    "country": "IT",
    "geo": "44.41344, 12.20121",
    "street": null, "postCode": null
  },
  "idnos": [
    { "type": "GND",      "value": "4048629-1" },
    { "type": "geonames", "value": "3169561" }
  ]
}

Organizzazioni
GET /api/v1/orgs

Lista paginata delle organizzazioni.

ParametroTipoDescrizione
searchstringRicerca sul nome
typestringTipo (es. library)
countryISO 3166Nazione
settlementstringCittà (lowercase)
pageintegerPagina (default: 1)
per_pageallSe all, restituisce tutti i risultati senza paginazione
Esempio richiesta
GET /api/v1/orgs?type=library&country=IT
Risposta
{
  "page": 1, "per_page": 25,
  "total": 25, "total_pages": 1,
  "items": [ { "id": "DLCL_CF_O0001", ... } ]
}
GET /api/v1/orgs/<id>

Dati di una singola organizzazione per ID.

Esempio richiesta
GET /api/v1/orgs/DLCL_CF_O0001
Risposta
{
  "id": "DLCL_CF_O0001",
  "sameAs": "http://viaf.org/viaf/122822452",
  "type": "library",
  "org_names": [
    { "name": "Istituzione Biblioteca Classense",
      "lang": "it" }
  ],
  "desc": null,
  "idnos": [
    { "type": "GND",  "value": "5007734-X" },
    { "type": "VIAF", "value": "122822452" }
  ],
  "location": {
    "country": "IT",
    "geo": "44.41453, 12.19994",
    "street": "Via Alfredo Baccarini 3",
    "postCode": "48121",
    "settlement": "Ravenna"
  }
}

Specifica OpenAPI

La specifica completa è disponibile in formato OpenAPI 3.1 (YAML). Puoi usarla per esplorare l'API interattivamente, generare client automatici in qualsiasi linguaggio, o integrare i dati in portali come Sampo-UI.

openapi.yaml
Importa in Swagger Editor
File → Import URL:
https://digiletclass.unibo.it
  /api/openapi.yaml

Errori
CodiceSignificato
200Successo
404Entità non trovata
404 risposta
{ "error": "Not found" }

Come citare

Se utilizzi questa API in una pubblicazione o progetto, cita il dataset TEI di origine:

Manca, Chiara. Carteggio Canneti-Fiacchi: Digital Edition Dataset. Zenodo. https://doi.org/10.5281/zenodo.14234727.