Transparenzportal

Aussenansicht des Staatsarchivs Hamburg

Transparenzportal

Sie lesen den Originaltext

Vielen Dank für Ihr Interesse an einer Übersetzung in leichte Sprache. Derzeit können wir Ihnen den Artikel leider nicht in leichter Sprache anbieten. Wir bemühen uns aber das Angebot zu erweitern.

Vielen Dank für Ihr Interesse an einer Übersetzung in Gebärdensprache. Derzeit können wir Ihnen den Artikel leider nicht in Gebärdensprache anbieten. Wir bemühen uns aber das Angebot zu erweitern.

Hinweise zur API

Hier finden Sie Informationen zum Umgang mit der API.

API, Application Programming Interface
© Foto: colourbox.de / Dizanna

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, die im beigefügten Metadaten-Modell beschrieben sind.