API

ETSO offre un’API pubblica per consultare da altri progetti i metadati delle opere del catalogo. L’API è pensata per riutilizzare identificatori, titoli, attribuzioni, link e il risultato stilometrico di ogni opera.

Le informazioni sono fornite in formato JSON e possono essere usate per integrare i dati di ETSO in cataloghi, visualizzazioni, motori di ricerca o strumenti di ricerca.

Endpoint

GET /api/obras

Restituisce il catalogo completo delle opere con i relativi metadati pubblici.

GET /api/obras/{id-o-slug}

Restituisce una singola opera usando il suo identificatore o slug pubblico.

Campi principali

Campo	Descrizione
`id`	Identificatore stabile dell’opera.
`slug`	Identificatore leggibile usato negli URL pubblici.
`title`	Titolo come compare nel database, incluso l’articolo finale quando presente.
`displayTitle`	Titolo trasformato con lo stesso processo usato dal sito ETSO.
`titleVariants`	Altri titoli dell’opera come compaiono nel database.
`displayTitleVariants`	Altri titoli trasformati con lo stesso processo usato dal sito.
`genre`	Genere dell’opera.
`origin`	Provenienza o fonte del testo usato da ETSO.
`textState`	Stato del testo nel catalogo.
`addedOn`	Data di inserimento nel catalogo, quando disponibile.
`resultado1`	Risultato stilometrico dell’opera in forma di frase.
`flags`	Indicatori booleani su rapporto, riassunto, esame delle autorie e accesso testuale.
`traditionalAttributionText`	Attribuzione tradizionale pronta per la visualizzazione.
`traditionalAttributionPhrase`	Frase di attribuzione tradizionale con testo, Markdown, HTML e parti collegabili.
`stylometryAttributionText`	Attribuzione stilometrica pronta per la visualizzazione.
`traditionalAttribution`	Attribuzione tradizionale normalizzata.
`stylometryAttribution`	Attribuzione stilometrica normalizzata.
`resources`	Link pubblici correlati all’interno di ETSO.

Uso consigliato

Le risposte sono servite con cache pubblica: public, max-age=3600, s-maxage=86400, stale-while-revalidate=604800. Per integrazioni esterne si consiglia di memorizzare localmente la risposta e di non chiamare l’API a ogni rendering.

Esempio

Query di un’opera specifica e risposta completa:

https://etso.es/api/obras/la-francesa-laura

{
  "meta": {
    "contentPolicy": {
      "includesFullText": false,
      "includesSummaries": false,
      "excludedFields": [
        "fullText",
        "text",
        "shortSummary",
        "summaryText",
        "resumen_breve",
        "resumen_largo"
      ]
    }
  },
  "work": {
    "id": "DESCONOCIDO_FrancesaLaura",
    "slug": "la-francesa-laura",
    "title": "Francesa Laura, La",
    "displayTitle": "La francesa Laura",
    "titleVariants": [],
    "displayTitleVariants": [],
    "genre": "Comedia",
    "origin": "El texto procede de la edición de Cuéllar y Vega.",
    "textState": "Bueno",
    "addedOn": "2021/03",
    "resultado1": "Los analisis de estilometria permiten asociar esta obra de forma clara con el perfil autorial de Lope de Vega Carpio.",
    "flags": {
      "inAuthorshipExam": true,
      "hasSummary": true,
      "hasReport": true,
      "hasTextAccess": true
    },
    "traditionalAttributionText": "Autoree ignoto",
    "traditionalAttributionPhrase": {
      "text": "Opera di attribuzione ignota.",
      "markdown": "Opera di attribuzione [ignota](https://etso.es/autores/desconocido).",
      "html": "Opera di attribuzione <a href=\"/autores/desconocido\">ignota</a>.",
      "parts": [
        {
          "kind": "text",
          "value": "Opera di attribuzione "
        },
        {
          "kind": "author",
          "value": "ignota",
          "authorId": "desconocido",
          "href": "/autores/desconocido",
          "url": "https://etso.es/autores/desconocido"
        },
        {
          "kind": "text",
          "value": "."
        }
      ]
    },
    "stylometryAttributionText": "Lope de Vega Carpio [Sicuro]",
    "traditionalAttribution": {
      "groups": [
        {
          "members": [
            {
              "authorId": "desconocido",
              "authorName": "Autoree ignoto"
            }
          ]
        }
      ],
      "connector": "and",
      "rawExpression": "desconocido"
    },
    "stylometryAttribution": {
      "groups": [
        {
          "members": [
            {
              "authorId": "vega_carpio_lope_de",
              "authorName": "Lope de Vega Carpio",
              "confidence": "segura"
            }
          ]
        }
      ],
      "connector": "and",
      "rawExpression": "vega_carpio_lope_de[segura]"
    },
    "resources": {
      "work": "/obras/la-francesa-laura",
      "summary": "/obras/la-francesa-laura/resumen",
      "report": "/informes/analisis-estilometrico-la-francesa-laura",
      "textAccess": [
        {
          "label": "Testo BITESO",
          "href": "/biteso/francesa-laura-la",
          "kind": "biteso"
        }
      ]
    }
  }
}