ThüCAT API-Schnittstelle
Allgemeines
Die Thüringer Content-Architektur Tourismus (ThüCAT) stellt Ihnen für Ihre Anwendungen oder die Anwendungen Ihrer Kunden touristische Basisdaten folgender Domainspezifikationen zur Verfügung:
- ttgds:Destination (Orte, Regionen und Landschaften)
- ttgds:Event (Veranstaltungen)
- ttgds:FoodEstablishmentLodgingBusiness (Gastronomie, Unterkünfte und Camping)
- ttgds:Organization (Vereine, Verbände und Organisationen)
- ttgds:PointOfInterest (Sehenswürdigkeiten, Kultur, Freizeit und Sport)
- ttgds:Trail (Wander-, Rad- und Wasserwege)
- ttgds:OtherInfraStructure (weitere Infrastrukturen)
- ttgds:Offer
- ttgds:Media (Bilder und andere Medien)
Die Daten stehen in folgenden Datenformaten bereit:
- html
- json
- xml
- jsonld
- jsonld-google
Die Daten stehen unter Creative-Commons-Lizenzen zur freien Nutzung zur Verfügung.
Zur Nutzung der Daten benötigen Sie einen API-Key, den Sie direkt von uns erhalten.
Bitte teilen Sie uns mit, in welchem Projekt die Daten verwendet werden sollen und welche Daten Sie konkret benötigen.
Neben dem API-Key stellen wir Ihnen einen oder mehrere Synchronisationsbereiche bereit, in denen die von Ihnen benötigten Daten ständig bereitstehen.
Unter https://cdb.thuecat.org/swagger finden Sie ein Schnittstellen-Interface. Dort können Sie die Schnittstelle testen und erhalten weitere nützliche Informationen zu den Datenstrukturen.
Gehen Sie bei der Nutzung des Schnittstellen-Interface wie folgt vor:
Tragen Sie den API-Key ein und klicken Sie den Button "Explore".
Schnittstelle GET /ext-sync/get-updated-nodes
Nutzen die Schnittstelle GET /ext-sync/get-updated-nodes aus des dem Abschnitt External sync API.
Mit an dieser Schnittstelle stehen Ihnen alle Datenbankentitäten des Synchronisationsbereichs zur Verfügung.
Übergeben Sie als Parameter syncScopeId den Key für den Synchronisationsbereich, den Sie von uns erhalten. Mit den optionalen Parametern from und to können Sie Datenabfragen in Bezug auf das letzte Änderungsdatum des Datensatzes einschränken.
Der Button "Try it out!" startet die Abfrage.
Dem Feld Request URL können Sie die URL für den Aufruf der Anfrage entnehmen.
Im Feld Response Body finden Sie im Abschnitt "createdOrUpdate" die nodeIdPart aller zur Verfügung stehenden Objekte.
Im Abschnitt "removed" finden Sie Entitäten, die nicht mehr in der Datenbank enthalten sind.
Dem Feld Response Code sind ggf. Fehlermeldungen zu fehlgeschlagenen Anfragen entnehmen.
Das Feld Response Header enthält den Header der Anfrage.
Schnittstelle GET /search/resources/{nodeIdPart}
Mit der Schnittstelle GET /search/resources/{nodeIdPart} können Sie alle Objekte mit allen Propertys abrufen. Übergeben Sie hierzu die mit der Schnittstelle GET /ext-sync/get-updated-nodes alles nodeIdPart einzeln als Parameter im Feld nodeIdPart .
Die Beschreibung der einzelnen Parameter finden Sie hinter dem Eingabefeld des Parameters.
Schnittstelle GET /crawl
Die Schnittstelle GET /crawl liefert direkt alle Daten eines Datensatzes inklusive der mit dem Datensatz verknüpften Datensätze und deren Eigenschaften. Dabei werden die Ergebnisse in standardmäßig in Paketen zu je 25 Datensätzen bereitgestellt.
Im Abschnitt _meta des Ergebnisses des Crawls werden die Parameter crawlId und nextID bereitgestellt. Die Werte dieser Parameter sind in der Schnittstelle zu übergeben um die nächsten Datenpakte abzurufen. Der Parameter furtherReceivableNodes gibt Auskunft darüber, wie viele Datensätze noch abzurufen sind.
Die Bedeutung an der anderen Schnittstellenfelder ist in der Anwendung dokumentiert. Um die Systemperfomance nicht negativ zu beeinflussen, bitten wir die den Wert des Feldes batchSize nicht zu verändern.
Vokabulare und Domainspecifications
Die Auszeichnungen in den Datenexporten beruhen auf den Vokabularen von:
www.schema.org
thuecat: https://thuecat.org/ontology/thuecat/1.0/
dachkg: https://thuecat.org/ontology/dachkg/1.0/
Das Vokabular thuecat mit allen Classes und Propertys können Sie auf https://semantify.it/voc/lhdRn5EgW einsehen.
Das Vokabular dachkg mit allen Classes und Propertys können Sie auf https://semantify.it/voc/nufne30dTf einsehen.
Folgende Domainspecifications werden als Datenschema genutzt:
| Domainspecification | Verwendet für Basiskategorie |
|---|---|
| ttgds:Audience | Zielgruppen |
| ttgds:Author | Autoren von Content |
| ttgds:Destination | Orte, Regionen und Landschaften |
| ttgds:Event | Veranstaltungen |
| ttgds:FoodEstablishmentLodgingBusiness | Gastronomie, Unterkünfte und Camping |
| ttgds:MeetingRoom | Tagungsräume |
| ttgds:Organization | Vereine, Verbände und Organisationen |
| ttgds:OtherInfraStructure | weitere Infrastruktur |
| ttgds:Person | Persönlichkeiten |
| ttgds:PointOfInterest | Sehenswürdigkeiten, Kultur, Freizeit und Sport |
| ttgds:Trail | touristische Wege |
| ttgds:Offer | touristische Angebote |
Die Label und Beschreibungen aller Classes, Propertys und Enumerations in deutscher Sprache finden Sie unter https://cms.thuecat.org/documents/35589/0/rdf-languages.csv
