Open Data

Nutzung

Die Inhalte des Wegweiser Kommune werden unentgeltlich von der Bertelsmann Stiftung zur Verfügung gestellt. Aufgrund der unterschiedlichen Lizenzbedingungen der verwendeten Rohdaten, die durch verschiedene Datenhalter bereit gestellt werden, stehen die Indikatoren unter der Datenlizenz Deutschland – Namensnennung – Version 2.0 zur Verfügung. Die Vervielfältigung und Verbreitung, auch auszugsweise, ist mit der Quellenangabe „Bertelsmann Stiftung/www.wegweiser-kommune.de“ zu versehen.

Informationen zu den Quellen und Datenhaltern der einzelnen Indikatoren finden Sie in den jeweiligen Erläuterungen bzw. Metadaten.

Download

Die Inhalte des Wegweiser Kommune können über die Daten-Seite zusammengestellt und dann über eine der Optionen heruntergeladen werden.

Je nach Darstellungsform stehen hierbei Downloads im PDF, Excel, CSV, JSON, SVG, JPEG, PNG oder GIF Format zur Verfügung.

Zu beachten ist, dass die Daten bei der Auswahl von sehr vielen Kommunen bzw. Indikatoren sowohl in der Oberfläche des Wegweiser Kommune als auch bei der Ausgabe nach PDF oder Excel abgeschnitten werden, um den Browser bzw. das jeweilige Zielsystem nicht zu überlasten. Die Daten können aber immer vollständig als CSV Dateien heruntergeladen werden, um sie in dafür geeigneten Werkzeugen weiterzuverwenden.

Schnittstelle

Um weitere Downloadoptionen anzugeben oder die Daten des Wegweiser Kommune direkt in eine eigene Anwendung einzubinden, stellen wir Ihnen eine sogenannte REST-Schnittstelle zur Verfügung.

OpenAPI Beschreibung

Die Beschreibung der Schnittstelle wird im OpenAPI-Format unter folgenden URLs angeboten:

https://www.wegweiser-kommune.de/openapi (OpenAPI Beschreibung im YAML-Format)
https://www.wegweiser-kommune.de/openapi?format=JSON (OpenAPI Beschreibung im JSON-Format)

Um diese eher formale Beschreibung komfortabel einzusehen und auszuwerten, stellt das Swagger-Projekt passende Werkzeuge bereit.

So kann mit dem Swagger UI die Schnittstelle grafisch dargestellt werden: Swagger UI für die Wegweiser Kommune Schnittstelle

Außerdem kann mit dem Swagger Editor direkt Clientcode für die meisten Programmiersprachen erzeugt werden, wodurch die Schnittstelle des Wegweiser Kommune direkt in andere Anwendungen integriert werden kann, ohne dass sich der Softwareentwickler mit den Details von OpenAPI beschäftigen muss: Swagger Editor für die Wegweiser Kommune Schnittstelle (zum Erstellen des Quelltextes ist im Menü "Generate Client" die gewünschte Programmiersprache auszuwählen).

Export-Endpunkt

Auch wenn es viele "Endpunkte" der Schnittstelle gibt, so soll im folgenden auf den wichtigsten eingegangen werden, den "Export". Dieser wird ebenfalls auf der Daten-Seite für den Download verwendet.

Der Export steht unter folgender URL zur Verfügung:

https://www.wegweiser-kommune.de/data-api/rest/export/{friendlyUrl}.{format}

Hiermit kann man eine Datenzusammenstellung in einem gewünschten Format exportieren. Das Format kann dabei eines der folgenden sein (wobei je nach Darstellungsform nicht alle Sinn machen):

• csv
• xls
• xlsx
• pdf
• json
• svg
• jpeg
• png
• gif

Nahezu alle Objekte im Wegweiser Kommune, ob Indikatoren, Themen, Themen-Sets oder Kommunen haben eine eindeutige ID und eine eindeutige Friendly-URL. Die (zumeist numerische) ID ist zwar kürzer, kann sich aber durch Datenaktualisierungen ändern. Daher wird sie nur von den eher internen Schnittstellen der Anwendung verwendet. Im Gegensatz dazu ist die Friendly-URL auch zwischen verschiedenen Datenständen immer die gleiche und wird daher für den Export verwendet. Der hier angegebene Platzhalter {friendlyURL} ist nun eine mit "+" getrennte Kombination aus den Friendly-URLs der einzelnen Objekte der Datenzusammenstellung.

Da man sich die {friendlyUrl} mit Hilfe der Daten-Seite zusammenstellen kann und um die Komplexität dieser Erläuterung so gering wie möglich zu halten, wird auf weitere Details zur Zusammensetzung verzichtet. Man beachte daher auch die Filtermöglichkeiten über "Weitere Kommunen auswählen" im Kommunenfeld.

Das heißt, die gewünschte {friendlyUrl} kann aus der Adresszeile des Browsers abgelesen werden (alles hinter dem letzten '/'), sobald man sich seine Datenauswahl zusammengestellt hat. Alternativ kann auch die URL des Download-Links kopiert werden (über das Kontextmenü des Browsers), da diese ja genau der gewünschten Export-URL entspricht.

Über die optionalen Parameter "charset", "width" und "raw" kann der Export außerdem weiter konfiguriert werden.

Beispiele:

• https://www.wegweiser-kommune.de/data-api/rest/export/geburten+sterbefaelle+kommunen-mit-200000-einwohnern-aus-brandenburg+2012-2019+tabelle.csv?charset=UTF-8
  Erstellt eine CSV Datei im UTF-8 Zeichensatz von den Geburten und Sterbefällen je 1000 Einwohner der Kommunen aus Brandenburg mit mehr als 200.000 Einwohnern für die Jahre 2012 - 2019.
• https://www.wegweiser-kommune.de/data-api/rest/export/geburten+berlin+guetersloh-gt+2012-2019+liniendiagramm.png?width=640&raw=true
  Erstellt ein Liniendiagramm der Geburten je 1000 Einwohner von Berlin und Gütersloh für die Jahre 2012 - 2019 mit der Breite 640 Pixel, welches auch in einer eigenen Webseite "live" eingebettet werden kann:
   
  Der Hinweis auf den Wegweiser Kommune als Quelle sollte in diesem Fall gesondert angegeben werden, zum Beispiel als Bildunterschrift. Wenn der Parameter "&raw=true" weggelassen wird, sind die Quellenangaben bereits im Bild enthalten.

Schnittstellenänderungen

Anpassungen an der Struktur des Wegweiser Kommune können es nötig machen, dass wir in Zukunft Änderungen an der Schnittstelle vornehmen müssen. Um die Komplexität des Wegweiser Kommune nicht weiter zu erhöhen, haben wir uns gegen eine (abwärtskompatible) Versionierung der Schnittstelle entschieden. Die aktuelle Version können Sie immer der OpenAPI-Beschreibung aus dem Feld "info - version" entnehmen.

Damit wir Sie bei einer Änderung der Schnittstelle proaktiv informieren können, wenn Sie den Wegweiser Kommune in einer Anwendung verwenden, würden wir uns über eine entsprechende Nachricht freuen. Den passenden Kontakt finden Sie hier: "Über uns".