Schnittstellen
Schnittstellen zum Lesen von Ressourcen
Zugriff per URL
Bei jeder Ressource ist über eine grüne Schaltfläche die URL erreichbar, mit der sie im Browser angezeigt oder als Datei heruntergeladen werden kann. Bitte beachten Sie:
- Nicht alle Formate lassen sich im Browser unmittelbar anzeigen; manche erfordern zur Weiterverarbeitung ein passendes Anwendungsprogramm.
- Einige Ressourcen liefern nur die Metadaten eines Datensatzes, nicht die dahinter liegenden Daten selbst.
- Einige Ressourcen werden in diesem Portal aufbereitet, so dass die Anzeige anders aussehen kann als die Daten zum Herunterladen. Es kann vorkommen, dass eine aufbereitete Variante nur bezogen werden kann mit einem Benutzerkonto beim Herausgeber und einem POST-Request.
Export in der Vorschau
Verschiedene Vorschau-Varianten haben eigene Exportfunktionen zum Herunterladen der angezeigten Daten, z.B. die Tabellenansicht auf statistische Daten und die Vorschau auf PDF- und Office-Dokumente.
Bei Geobasisdiensten wird i.d.R. die Capabilities-URL angegeben, über die sich Eigenschaften und Inhalte des Dienstes erschließen lassen. Dazu benötigt man ggf. ein geografisches Informationssystem (GIS) wie z.B. QGIS. Wo es möglich ist, wird ein Link auf das Geoportal Hessen angeboten, das weitergehende Funktionen zum Umgang mit dem Dienst enthält.
OpenAPI
Wenn die Ressource eine Schnittstelle enthält für die Formulierung variabler Zugriffe, wie etwa bei den Formaten REST und OGC API Features, dann wird nach Möglichkeit eine OpenAPI-Beschreibung ausgegeben und die Open-Source-Variante von Swagger eingebunden, mit der sich die Schnittstelle an Ort und Stelle ausprobieren lässt.
DataStore und Datenverzeichnis
Ressourcen mit tabellarischen Daten werden in vielen Fällen als Vorschau auf einen "DataStore" angezeigt, der individuelle Zugriffe, wie das Sortieren und Filtern von Daten, erleichtert. In diesen Fällen wird ein Datenverzeichnis gebildet, in dem der Herausgeber weitere Metadaten zu den Spalten der Tabelle hinterlegen kann. Das ist die Grundlage für ein (ggf. standardisiertes) Tabellen-Schema und für die Erzeugung von Linked Open Data.
In Abstimmung mit der Zentralen Stelle Open Data können mit der Data API von CKAN herausgeber-spezische Datenmodelle aufgebaut werden, in denen aus verschiedenen Basistabellen neue Sichten für den Nutzer gebildet werden.
Schnittstellen zum Lesen von Metadaten
Datensatz als RDF
Die Metadaten jedes Datensatzes lassen sich per URL als RDF-Graph in verschiedenen Formaten (Turtle, N3, XML, JSON-LD) abrufen. Der Graph entspricht dem Metadaten-Standard DCAT-AP.de.
Datensatz als JSON
Mit der "Action API" unserer Open-Data-Plattform CKAN können die Metadaten für jeden Datensatz im JSON-Format bezogen werden, um sie client-basiert (z.B. mit JavaScript) oder server-basiert (z.B. mit Python) zu verarbeiten. Dafür genügt im einfachsten Fall ein GET-Request.
Katalog als RDF
Ein Katalog aller Metadaten dieses Portals lässt sich per URL als RDF-Graph auslesen.
Katalog als JSON
Prinzipiell lässt sich mit der API von CKAN der Katalog im JSON-Format beziehen oder auch eine gefilterte Suche nach Datensätzen abbilden wie bei der Datensatzsuche in diesem Portal. Als Hilfestellung gibt es unter diversen Listen mit Datensätzen eine Schaltfläche "API". Darüber lassen sich der passende API-Aufruf anzeigen, der zu der angezeigten Menge an Datensätzen führt, und das Ergebnis dieses Aufrufs im JSON-Format.
SPARQL
Zugriffe auf RDF-Graphen per SPARQL sind noch in Vorbereitung.
Weitere Schnittstellen
Einbetten einer Vorschau
Die Vorschau auf eine Ressource lässt sich z.B. in die eigene Website einbetten mit dem HTML-Element iframe. An jeder Vorschau kann mit einer Schaltfläche der entsprechende HTML-Code abgerufen und kopiert werden.
Spezielle Schnittstellen in den kommunalen Dasboards
In den kommunalen Dashboards zu allen Gebietskörperschaften in Hessen sind Schnittstellen zu verschiedenen offenen Datenquellen des Landes enthalten. Manche davon erfordern die Registrierung eines Benutzerkontos und haben eigene Lizenzbedingungen. Die Benutzerkonten für dieses Portal sind nicht offengelegt. Wenn Sie eine solche Schnittstelle nutzen wollen, wenden Sie sich an den jeweiligen Herausgeber der Datenquelle. Die Schaltfläche API dient zur Veranschaulichung, welche Datenstruktur für die aktuelle Anzeige abgerufen werden kann. Diese Daten lassen sich aber nicht durch eine Abfrage an dieses Portal beziehen.