Wie benutzt man die DKAN API

Über das Portal ist es nicht nur möglich, sich Datensätze anzuschauen und herunterzuladen. Man kann ausgewählte Datensätze auch direkt über URL ansprechen und so, programmgesteuert, mit diesen arbeiten. Grundsätzlich funktioniert dies über eine API (Programmierschnittstelle), die lesenden Zugriff auf Portalinhalte ermöglicht. Im Folgenden wird die API und deren Möglichkeiten veranschaulicht.

Die Stadt Bielefeld referenziert in ihren Datensätzen meist Adressen auf dem Bielefelder Internetauftritt. Dort liegen CSV-Dateien und andere Ressourcen. Der zweite häufig verwendete Bereich sind die Dienste des Geoportals der Stadt Bielefeld.

1. Dataset API

Diese API bezieht sich auf das Portal und dessen Inhalte im Allgemeinen. So ist es möglich, den Zustand des Portals auszulesen bis hin zu einer Ausgabe aller vorhandenen Datensätze. Zu erreichen sind die einzelnen Funktionen unter https://open-data.bielefeld.de/api/3/action/{Name der Funktion} wobei {Name der Funktion} mit einer der unten gelisteten Funktionen zu besetzen ist. Die Ausgabe erfolgt immer im json Format.

Funktion site_read

Beschreibung: Zeigt an, ob das Portal grundsätzlich erreichbar ist

Beispielaufruf: https://open-data.bielefeld.de/api/3/action/site_read

Rückgabetyp: Boolean

Funktion package_list

Beschreibung: Liefert eine Liste mit allen Datensatz Containern (Dataset)

Beispielaufruf: https://open-data.bielefeld.de/api/3/action/package_list

Rückgabetyp: List of Dictionaries

Funktion package_show

Beschreibung: Liefert die Metadaten eines Datasets und dessen Ressourcen

Parameter: id

Beispielaufruf: https://open-data.bielefeld.de/api/3/action/package_show?id=1398

Rückgabetyp: Dictionary

2. Geodaten API

Die Geodaten der Stadt Bielefeld werden nach internationalen Standards (ISO und OGC) als Webdienste zur Verfügung gestellt. Downloaddienste können Daten als CSV, GML und Shapefile anbieten. Diese Daten sind im Gegensatz zu zentral gespeicherten CSV-Dateien immer aktuell.