Nutzung der Daten

Alle veröffentlichten Datensätze können direkt über die Portaloberfläche sowie über technische Schnittstellen (APIs) automatisiert abgerufen werden. Dadurch stehen die Daten sowohl für die interaktive Nutzung im Browser als auch für die Weiterverarbeitung in externen Anwendungen zur Verfügung.

Interaktive Nutzung im Portal

Für tabellarisch strukturierte Datensätze steht ein integrierter Datentabellen-Viewer zur Verfügung. Dieser ermöglicht eine komfortable Analyse der Daten direkt im Browser und bietet umfangreiche Funktionen zur Filterung, Sortierung und Darstellung.

Der Datentabellen-Viewer unterstützt unter anderem:

  • Hervorhebung von Suchergebnissen
  • Filterung auf Spaltenebene
  • Mehrspaltige Sortierung
  • Zwei Darstellungsmodi: Tabellenansicht, Listenansicht (responsive Darstellung mit Detailansicht einzelner Datensätze)
  • Gefilterte Datenexporte
  • Ein- und Ausblenden von Spalten
  • Kopieren von Daten in die Zwischenablage sowie Druckfunktion für gefilterte Ergebnisse und ausgewählte Zeilen
  • Ergänzendes Datenverzeichnis mit Variablenbeschreibungen (zusätzliche Anzeige per Mouseover)

Download und Weiterverarbeitung

Je nach Art der bereitgestellten Ressource stehen unterschiedliche Download-Optionen zur Verfügung.

Für maschinenlesbare, strukturierte Datensätze stehen flexible Exportmöglichkeiten in folgenden Formaten zur Verfügung:

  • CSV
  • TSV
  • XLSX
  • JSON
  • XML

Damit lassen sich die Daten einfach in unterschiedlichen Anwendungen, Analyseumgebungen oder Systemen weiterverarbeiten.

Dateien (Ressourcen), die als PDF veröffentlicht werden, stehen ausschließlich in diesem Format zum Download bereit.

Zugriff über Schnittstellen (APIs)

Für die automatisierte Nutzung der Daten stellt das Portal offene API-Schnittstellen bereit. Diese ermöglichen den direkten Zugriff auf Metadaten sowie, sofern die jeweilige Ressource im DataStore verfügbar ist, auf strukturierte Datensätze.

Die Schnittstellen basieren auf HTTP-Anfragen und liefern Ergebnisse in der Regel im JSON-Format. Viele grundlegende Datenabfragen können dabei ohne Authentifizierung durchgeführt werden. Ein API-Token ist nur für geschützte Inhalte oder administrative Funktionen erforderlich.

Typische Anwendungsfälle sind automatisierte Datenabfragen in Skripten, regelmäßige Aktualisierungen in Anwendungen oder die Integration der Daten in eigene Systeme.

Begriffe und Datenstruktur

Zur besseren Einordnung der Schnittstellen werden folgende zentrale Begriffe verwendet:

  • Datensatz (Package):
    Ein Datensatz ist die oberste organisatorische Einheit und fasst thematisch zusammengehörige Daten und Informationen zusammen.
  • Ressource (Resource):
    Eine Ressource ist eine einzelne Datei oder Datentabelle innerhalb eines Datensatzes, z. B. eine CSV-Datei oder ein PDF-Dokument.
  • DataStore:
    Der DataStore ist eine Schnittstelle für strukturierte, tabellarische Daten. Er ermöglicht den direkten Zugriff auf einzelne Datensätze über die API sowie Filter- und Suchfunktionen. Die technische Umsetzung basiert auf einer relationalen Datenbank (PostgreSQL), die im Hintergrund von CKAN verwaltet wird.

Wichtige API-Endpunkte

Je nach Anwendungsfall stehen verschiedene API-Endpunkte zur Verfügung:

  • Datensatzsuche: package_search
    Suche und Filterung von Datensätzen und Metadaten im gesamten Portal.
  • Datensatzdetails: package_show
    Liefert vollständige Informationen zu einem einzelnen Datensatz, einschließlich Ressourcen und Metadaten.
  • Ressourcenzugriff über DataStore: datastore_search
    Direkter Zugriff auf tabellarische Daten innerhalb einer Ressource mit Filter- und Abfragefunktionen.
  • Ressourceninformationen: resource_show
    Technische Details zu einer einzelnen Datenressource.

Authentifizierung

Für einfache API-Abfragen ist keine Authentifizierung erforderlich. Viele Datensätze können direkt über HTTP-Anfragen abgerufen werden. Ein API-Token wird nur benötigt, wenn auf geschützte Inhalte zugegriffen oder erweiterte Funktionen genutzt werden sollen.

Weitere Informationen

Eine vollständige technische Dokumentation der CKAN API ist hier verfügbar:
CKAN API Dokumentation (maßgeblich ist die Dokumentation der auf diesem Portal eingesetzten CKAN-Version).