API

O ETSO oferece uma API pública para consultar, a partir de outros projetos, os metadados das obras do catálogo. A API foi pensada para reutilizar identificadores, títulos, atribuições, links e o resultado estilométrico de cada obra.

As informações são entregues em formato JSON e podem ser usadas para integrar os dados do ETSO em catálogos, visualizações, mecanismos de busca ou ferramentas de pesquisa.

Endpoints

GET /api/obras

Devolve o catálogo completo de obras com seus metadados públicos.

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

Devolve uma única obra usando seu identificador ou slug público.

Campos principais

Campo	Descrição
`id`	Identificador estável da obra.
`slug`	Identificador legível usado nas URLs públicas.
`title`	Título como aparece na base de dados, incluindo o artigo final quando existir.
`displayTitle`	Título transformado com o mesmo processo usado pelo site do ETSO.
`titleVariants`	Outros títulos da obra como aparecem na base de dados.
`displayTitleVariants`	Outros títulos transformados com o mesmo processo usado pelo site.
`genre`	Gênero da obra.
`origin`	Procedência ou fonte do texto usado pelo ETSO.
`textState`	Estado do texto dentro do catálogo.
`addedOn`	Data de incorporação ao catálogo, quando consta.
`resultado1`	Resultado estilométrico da obra em forma de frase.
`flags`	Indicadores booleanos sobre relatório, resumo, exame de autorias e acesso textual.
`traditionalAttributionText`	Atribuição tradicional pronta para exibição.
`traditionalAttributionPhrase`	Frase de atribuição tradicional com texto, Markdown, HTML e partes linkáveis.
`stylometryAttributionText`	Atribuição estilométrica pronta para exibição.
`traditionalAttribution`	Atribuição tradicional normalizada.
`stylometryAttribution`	Atribuição estilométrica normalizada.
`resources`	Links públicos relacionados dentro do ETSO.

Uso recomendado

As respostas são servidas com cache público: public, max-age=3600, s-maxage=86400, stale-while-revalidate=604800. Para integrações externas, recomenda-se armazenar a resposta em cache localmente e não chamar a API a cada renderização.

Exemplo

Consulta de uma obra específica e resposta 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": "Autor desconhecido",
    "traditionalAttributionPhrase": {
      "text": "Obra de atribuição desconhecida.",
      "markdown": "Obra de atribuição [desconhecida](https://etso.es/autores/desconocido).",
      "html": "Obra de atribuição <a href=\"/autores/desconocido\">desconhecida</a>.",
      "parts": [
        {
          "kind": "text",
          "value": "Obra de atribuição "
        },
        {
          "kind": "author",
          "value": "desconhecida",
          "authorId": "desconocido",
          "href": "/autores/desconocido",
          "url": "https://etso.es/autores/desconocido"
        },
        {
          "kind": "text",
          "value": "."
        }
      ]
    },
    "stylometryAttributionText": "Lope de Vega Carpio [Segura]",
    "traditionalAttribution": {
      "groups": [
        {
          "members": [
            {
              "authorId": "desconocido",
              "authorName": "Autor desconhecido"
            }
          ]
        }
      ],
      "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": "Texto BITESO",
          "href": "/biteso/francesa-laura-la",
          "kind": "biteso"
        }
      ]
    }
  }
}