API

ETSO는 다른 프로젝트에서 카탈로그 작품의 메타데이터를 조회할 수 있는 공개 API를 제공합니다. 이 API는 각 작품의 식별자, 제목, 귀속, 링크, 문체계량 결과를 재사용하도록 설계되었습니다.

정보는 JSON 형식으로 제공되며 ETSO 데이터를 카탈로그, 시각화, 검색 시스템 또는 연구 도구에 통합하는 데 사용할 수 있습니다.

엔드포인트

GET /api/obras

공개 메타데이터가 포함된 전체 작품 카탈로그를 반환합니다.

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

식별자 또는 공개 slug를 사용해 단일 작품을 반환합니다.

주요 필드

필드	설명
`id`	작품의 안정적인 식별자입니다.
`slug`	공개 URL에서 사용하는 읽기 쉬운 식별자입니다.
`title`	데이터베이스에 저장된 제목이며, 끝에 오는 관사가 있으면 포함합니다.
`displayTitle`	ETSO 웹사이트와 같은 절차로 변환된 제목입니다.
`titleVariants`	데이터베이스에 저장된 작품의 다른 제목입니다.
`displayTitleVariants`	웹사이트와 같은 절차로 변환된 다른 제목입니다.
`genre`	작품의 장르입니다.
`origin`	ETSO가 사용하는 텍스트의 출처입니다.
`textState`	카탈로그 내 텍스트 상태입니다.
`addedOn`	기록이 있을 경우 카탈로그에 추가된 날짜입니다.
`resultado1`	작품의 문체계량 결과를 문장 형태로 제공합니다.
`flags`	보고서, 요약, 저자 귀속 조사, 텍스트 접근에 관한 불리언 표시입니다.
`traditionalAttributionText`	표시용 전통적 귀속입니다.
`traditionalAttributionPhrase`	텍스트, Markdown, HTML, 링크 가능한 부분을 포함한 전통적 귀속 문장입니다.
`stylometryAttributionText`	표시용 문체계량 귀속입니다.
`traditionalAttribution`	정규화된 전통적 귀속입니다.
`stylometryAttribution`	정규화된 문체계량 귀속입니다.
`resources`	ETSO 내부의 관련 공개 링크입니다.

권장 사용법

응답은 공개 캐시와 함께 제공됩니다: public, max-age=3600, s-maxage=86400, stale-while-revalidate=604800. 외부 연동에서는 응답을 로컬에 캐시하고 렌더링마다 API를 호출하지 않는 것을 권장합니다.

예시

특정 작품 조회와 전체 응답:

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": "작자 미상",
    "traditionalAttributionPhrase": {
      "text": "귀속이 알려지지 않은 작품.",
      "markdown": "귀속이 [알려지지 않은 작품](https://etso.es/autores/desconocido).",
      "html": "귀속이 <a href=\"/autores/desconocido\">알려지지 않은 작품</a>.",
      "parts": [
        {
          "kind": "text",
          "value": "귀속이 "
        },
        {
          "kind": "author",
          "value": "알려지지 않은 작품",
          "authorId": "desconocido",
          "href": "/autores/desconocido",
          "url": "https://etso.es/autores/desconocido"
        },
        {
          "kind": "text",
          "value": "."
        }
      ]
    },
    "stylometryAttributionText": "Lope de Vega Carpio [안전한]",
    "traditionalAttribution": {
      "groups": [
        {
          "members": [
            {
              "authorId": "desconocido",
              "authorName": "작자 미상"
            }
          ]
        }
      ],
      "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": "텍스트 BITESO",
          "href": "/biteso/francesa-laura-la",
          "kind": "biteso"
        }
      ]
    }
  }
}