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"
        }
      ]
    }
  }
}