Nachnutzbare Metadaten: APIs und Export
TODO: Highlight Box Schnittstellen-Übersicht Wenn Sie direkt loslegen wollen, bieten wir auch eine dokumentierte Übersicht direkt in unserer Schnittstelle an
Schnittstellen und Metadatenstandards
Neben unserer Suche nach Umwelt- und Naturschutzinformationen können Sie die Metadaten unserer Datensätze auch über eine Anwendungsschnittstelle (API) abrufen. Dort lassen sich alle Metadaten in unserem eigenen Schema exportieren. Zusätzlich wollen wir den Export über verschiedene Schnittstellen nach etablierten Standards ermöglichen.
Da es derzeit verschiedene Standards für die Übertragung von Metadaten gibt, haben wir unsere Netzwerkpartner aus Zivilgesellschaft, Wissenschaft und Verwaltung im September 2024 gefragt, welche Standards sie bevorzugen. Ergebnis der Umfrage war, dass Nutzende vor allem die Standards CKAN, DCAT-AP, schema.org, CSW oder Dublin Core bevorzugen. Aktuell bieten wir den Export per CKAN an, später sollen weitere folgen.
CKAN
Wir bieten ein CKAN-kompatibles Metadatenschema auf Grundlage unseres internen Schemas an. Diese Konvertierung kann am besten im Quellcode nachvollzogen werden.
Bei umwelt.info stellen wir zwei Endpunkte der API zur Verfügung:
- package_search erlaubt das Ausführen einer Suche und antwortet mit den Inhalten der zum Suchergebnis passenden Datensätze. Die Suche mit einer Wildcard * ermöglicht die Abfrage des gesamten Metadatenbestandes auf umwelt.info.
- package_show ermöglicht die Abfrage einzelner Datensätze im CKAN Format. Da wir unseren Standard in ein standardisiertes Schema konvertieren, kann es möglicherweise zu Informationsverlusten kommen. So lässt CKAN beispielsweise nur die Nennung eines einzelnen Autors oder Herausgebers zu, während unser internes Schema mehrere Einträge in diesem Feld ermöglicht.
Damit Daten, für die es keine eindeutige Zuordnung gibt, trotzdem verfügbar bleiben, nutzen wir das im CKAN-Standard vorgesehene Feld „Extras“, welches eine beliebige Zahl von frei definierbaren Einträgen zulässt. Dabei folgen wir weitestgehend der Nutzung dieses Feldes durch den CKAN-Export der Metadaten von GovData .
Umfrage zu den gewünschten standardisierten Metadatenschnittstellen auf umwelt.info
Warum halten wir es für wichtig, standardisierte Metadaten zum Export anzubieten?
Wir speichern für umwelt.info Metadaten in einem internen Standard, der möglichst vollständig und flexibel die semantischen Informationen der Daten abbildet. Die Metadaten können in diesem Schema bereits über die API nachgenutzt werden. Wir passen dieses Schema je nach Bedarf immer wieder an und können daher keine stabile API anbieten.
Durch den Metadatenexport in etablierten Standards schließen wir diese Lücke und können stabile Schnittstellen bereitstellen. Dadurch bietet umwelt.info die Möglichkeit, Metadaten aus unterschiedlichen Quellen mit unterschiedlichen Schnittstellen in einem gemeinsamen Standard zu vergleichen.