API

ETSO stellt eine öffentliche API bereit, mit der andere Projekte die Metadaten der Werke im Katalog abrufen können. Die API ist dafür gedacht, Kennungen, Titel, Zuschreibungen, Links und das stilometrische Ergebnis jedes Werkes wiederzuverwenden.

Die Informationen werden im JSON-Format geliefert und können in Kataloge, Visualisierungen, Suchsysteme oder Forschungswerkzeuge integriert werden.

Endpoints

GET /api/obras

Gibt den vollständigen Werkkatalog mit seinen öffentlichen Metadaten zurück.

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

Gibt ein einzelnes Werk anhand seiner Kennung oder seines öffentlichen Slugs zurück.

Hauptfelder

Feld	Beschreibung
`id`	Stabile Werkkennung.
`slug`	Lesbare Kennung, die in öffentlichen URLs verwendet wird.
`title`	Titel wie in der Datenbank gespeichert, einschließlich nachgestelltem Artikel, falls vorhanden.
`displayTitle`	Titel, der mit demselben Verfahren umgeformt wird wie auf der ETSO-Website.
`titleVariants`	Weitere Werktitel wie in der Datenbank gespeichert.
`displayTitleVariants`	Weitere Titel, die mit demselben Verfahren wie auf der Website umgeformt werden.
`genre`	Gattung des Werkes.
`origin`	Herkunft oder Quelle des von ETSO verwendeten Textes.
`textState`	Textzustand im Katalog.
`addedOn`	Datum der Aufnahme in den Katalog, sofern vorhanden.
`resultado1`	Stilometrisches Ergebnis des Werkes als Satz.
`flags`	Boolesche Angaben zu Bericht, Zusammenfassung, Autorschaftsprüfung und Textzugang.
`traditionalAttributionText`	Traditionelle Zuschreibung zur direkten Anzeige.
`traditionalAttributionPhrase`	Satz der traditionellen Zuschreibung mit Text, Markdown, HTML und verlinkbaren Teilen.
`stylometryAttributionText`	Stilometrische Zuschreibung zur direkten Anzeige.
`traditionalAttribution`	Normalisierte traditionelle Zuschreibung.
`stylometryAttribution`	Normalisierte stilometrische Zuschreibung.
`resources`	Zugehörige öffentliche Links innerhalb von ETSO.

Empfohlene Nutzung

Antworten werden mit öffentlichem Cache ausgeliefert: public, max-age=3600, s-maxage=86400, stale-while-revalidate=604800. Für externe Integrationen wird empfohlen, die Antwort lokal zwischenzuspeichern und die API nicht bei jedem Rendern aufzurufen.

Beispiel

Abfrage eines bestimmten Werkes und vollständige Antwort:

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": "Unbekannt",
    "traditionalAttributionPhrase": {
      "text": "Werk mit unbekannter Zuschreibung.",
      "markdown": "Werk mit [unbekannter Zuschreibung](https://etso.es/autores/desconocido).",
      "html": "Werk mit <a href=\"/autores/desconocido\">unbekannter Zuschreibung</a>.",
      "parts": [
        {
          "kind": "text",
          "value": "Werk mit "
        },
        {
          "kind": "author",
          "value": "unbekannter Zuschreibung",
          "authorId": "desconocido",
          "href": "/autores/desconocido",
          "url": "https://etso.es/autores/desconocido"
        },
        {
          "kind": "text",
          "value": "."
        }
      ]
    },
    "stylometryAttributionText": "Lope de Vega Carpio [Sicher]",
    "traditionalAttribution": {
      "groups": [
        {
          "members": [
            {
              "authorId": "desconocido",
              "authorName": "Unbekannt"
            }
          ]
        }
      ],
      "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": "Text BITESO",
          "href": "/biteso/francesa-laura-la",
          "kind": "biteso"
        }
      ]
    }
  }
}