Hinweise zur API
Hier finden Sie Informationen zum Umgang mit der API.
Was ist eine API?
Bei einer API (Application programming interface) handelt es sich um eine Programmierschnittstelle, mit der z.B. Inhalte und Metadaten aus dem Transparenzportal automatisiert abrufen lassen. Auf diesem Wege gelangen beispielsweise Datensätze aus dem Transparenzportal Hamburg in das GovData-Portal, in dem Verwaltungsdaten aus ganz Deutschland zentral recherchierbar sind.
Nutzung der API des Transparenzportals
Das Transparenzportal Hamburg nutzt die etablierte Open-Source-Software CKAN, um veröffentlichte Dokumente und Daten sowie die dazugehörigen Metadaten zu verwalten und Nutzern zugänglich zu machen. Zurzeit wird die CKAN-Version 2.9.7 genutzt. Informationen zu dieser Version finden Sie in dieser Dokumentation zur API des CKAN.
Über eine API kann ein direkter Zugriff auf die im CKAN gespeicherten Dokumente und Datensätze gemäß den im Transparenzportal genannten Lizenzbedingung erfolgen.
Als grundlegendes Format für den Austausch dient das Datenformat JSON (JavaScript Object Notation).
Beispiel für einen einfachen API-Aufruf nach dem Stichwort "elbe":
http://suche.transparenz.hamburg.de/api/3/action/package_search?q=elbe
Metadaten-Modell
Über die Standard-API (http://suche.transparenz.hamburg.de/api/3/action) hinaus, verwendet das Transparenzportal zusätzliche Felder.
Weitere Erläuterungen zur Verwendung der API
In der Anleitung zur CKAN-API wird gezeigt, dass auf besondere Felder mit dem Parameter "fq" zugegriffen wird (dort "fq=tags:economy").
Mit diesem Verfahren können auch auf die Felder des Transparenzportals Hamburg zugegriffen werden,
z.B.:
Alle Datensätze mit Informationsgegenstand "Verwaltungsvorschriften"
https://suche.transparenz.hamburg.de/api/3/action/package_search&fq=extras_registerobject_type:verwaltungsvorschriften
Die CKAN-API erlaubt unseres Wissens nur die Filterung mit einem Parameter. Daher müssten Sie nach dem Aufruf mit obigem API-Call, z.B. mit einem Python-Programm, gemäß des zweiten gewünschten Parameters (dataset_type=document) filtern.
Hier finden Sie die internen Feldnamen für die Verwendung in der API mit dem Parameter "fq".
Bei dem aufgeführten Beispiel wurde das Feld "extras_registerobject_type", welches den Informationsgegenstand bezeichnet (siehe Anleitung zur API), verwendet.
"id":"0f00990c-7f14-439e-87cb-1e8a0b9ec7b0",
"name":"test-upload-2021-05-11-mehrere-grosse-dateien50",
"title":"Test Upload 2021-05-11 (mehrere große Dateien)",
"author":"Landgericht Hamburg",
"maintainer":"Fachliche Leitstelle Transparenzportal",
"maintainer_email":"transparenzportal@bkm.hamburg.de",
"notes":"Test Upload 2021-05-11 (mehrere große Dateien)",
"license_id":"dl-de-by-2.0",
"metadata_created":"2022-11-28T01:32:19.937Z",
"metadata_modified":"2022-11-28T01:32:19.937Z",
"state":"active",
"extras_dcatgroups":"[{\"name\": \"ECON\"}, {\"name\": \"ENVI\"}]",
"extras_latestVersion":"false",
"extras_mainDocument":"true",
"extras_metadata_original_id":"ELDORADO_:0ef72142-93bb-4001-a7dd-100664ca6383",
"offline_date":"2031-06-11T00:00:00Z",
"publishing_date":"2021-05-11T00:00:00Z",
"extras_registerobject_type":"dienstanweisungen, geodaten",
"extras_temporal_granularity_factor":"1",
"extras_terms_of_use":"{\"license_id\": \"dl-de-by-2.0\", \"license_url\": \"http://www.govdata.de/dl-de/by-2-0\", \"attribution_text\": \"Namensnennung: Freie und Hansestadt Hamburg\", \"is_free_to_use\": true}",
"tags":["Test Upload 2021-05-11 mehrere große Dateien"],
"groups":["geografie-geologie-und-geodaten",
"umwelt-und-klima",
"verbraucherschutz",
"wirtschaft-und-arbeit"],
"res_name":["Upload: NEFF_Backoefen_2015",
"Upload: NEFF_Prospekt_MegaCollection_2015",
"Upload: Bauhaus Terrassenüberdachung - Pavillions - Sonnenschirme und -segel"],
"res_format":["PDF",
"PDF",
"PDF"],
"res_url":["http://sta-daten.transparenz.hamburg.de/Dataport.HmbTG.ZS.Webservice.GetRessource100/GetRessource100.svc/9ad66758-a8c9-4d01-8992-1307b527bd2c/Upload__NEFF_Backoefen_2015.pdf",
"http://sta-daten.transparenz.hamburg.de/Dataport.HmbTG.ZS.Webservice.GetRessource100/GetRessource100.svc/b1823889-464f-436e-a34c-c87724f8cc02/Upload__NEFF_Prospekt_MegaCollection_2015.pdf",
"http://sta-daten.transparenz.hamburg.de/Dataport.HmbTG.ZS.Webservice.GetRessource100/GetRessource100.svc/125fc7b7-9927-43bb-9a28-50ccf9af570a/Upload__Bauhaus_Terrassenueberdachung_-_Pavillions_-_Sonnenschirme_und_-segel.pdf"],
"entity_type":"package",
"dataset_type":"document",
Hier finden Sie mögliche Parameter: suche.transparenz.hamburg.de/api/rest/enums