Skip the Navigation Links | Startseite | Alle Seiten | Zuletzt geändert | Autoren | Feeds | Export

Dokumentation

Die API.LEIPZIG ist ein Application Programming Interface (API) für den Zugriff auf öffentliche Daten der Stadt Leipzig. Zu Beginn können wir Ihnen die Datenquellen Branchenhandbuch Medien der Region Leipzig und den Veranstaltungskalender der Kultur- und Kreativwirtschaft zur Verfügung stellen.

Die API-Funktionen sind von der jeweils verwendeten Datenquelle abhängig. Für den Zugriff wird eine synchronisierte Kopie der Original-Datenquelle verwendet.

Wie viele populäre APIs, verwendet auch die API.LEIPZIG eine REST – Schnittstelle. Alle Abfragen können also sehr einfach über HTTP ausgeführt werden.

Die ersten Schritte für API.LEIPZIG-Entwickler

  1. Registrieren Sie sich als API.LEIPZIG-Entwickler. In Ihrem Nutzerprofil erhalten Sie den API-Key, den Sie für Ihre Anwendungen benötigen.
  2. Informieren Sie sich, auf welche Datenquellen Sie über die API.LEIPZIG zugreifen können.
  3. Je nach Anwendungsidee benötigen Sie Zugriff auf verschiedene Ressourcen der jeweiligen Datenquelle.
  4. Die Rückgabe der angeforderten Daten können Sie über weitere Parameter beeinflussen und nach bestimmten Suchkriterien filtern.
  5. Unsere Beispielabfragen und Codebeispiele helfen Ihnen beim weiteren Verständnis der API.LEIPZIG.
  6. Wenn Sie mal nicht weiterkommen, hilft vielleicht ein Blick in unsere Tipps zur Arbeit mit der API.LEIPZIG. Wenn nicht, helfen wir Ihnen gern persönlich weiter. Bitte besuchen Sie dazu für Ideen und allgemeine Fragen unser Feedback-Forum und für alle speziellen Fragen unser Entwickler-Forum. Für aktuelle Informationen folgen Sie uns am besten auf Twitter @apileipzig.
  7. Bitte hinterlassen Sie uns ohne Anmeldung Feedback und ergänzen Sie die Dokumentation. Die gesamte Dokumentation ist in einem Wiki gespeichert, so dass Sie sie einfach bearbeiten können. Den Link zum Bearbeiten der angezeigten Seite finden Sie immer am Seitenende.

Inhalte der Dokumentation

allgemeine Informationen Sie finden einführende Informationen auf dieser Seite.
Datenquellen Hier finden Sie alle zur Zeit verfügbaren Datenquellen.
Ressourcen Welchen Inhalt die einzelnen Datenquellen haben können, finden Sie hier.
allgemeine Parameter Mit allgemeinen Parametern können Sie ihre Abfragen spezifizieren, um nur die Daten zu bekommen, die Sie möchten.
Die API durchsuchen Eine weitere Möglichkeit auf Daten zuzugreifen, ist die Möglichkeit einzelne Ressourcen zu durchsuchen.
Beispielabfragen Hier finden Sie eine Reihe von Beispielanfragen, wie die API angesprochen werden kann.
Quellcode-Beispiele Beispielanwendungen in verschiedenen Programmiersprachen finden Sie hier.
weitere Tipps Weitere Tipps die für die Arbeit mit der API beachtet werden sollen, finden Sie hier.

Aufbau der API.LEIPZIG

Die API.LEIPZIG ermöglicht den Zugriff auf verschiedene Datenquellen in folgender Struktur.

API
 |
 +--Datenquelle 1
 |    |
 |    +--Resource 1
 |    +--Resource 2
 |    +--Resource 3
 |
 +--Datenquelle 2
 |    |
 |    +--Resource 1
 |    +--Resource 2
 |    +--Resource 3
 |
 +--Datenquelle 3
 |
 + ...

Über URL-Parameter lassen sich nach dem REST-Prinzip individuelle Abfragen definieren.

Zum Beispiel:
api/v1/mediahandbook/companies

Nutzerauthentifizierung der API

Zur Verwendung der API.LEIPZIG muss jeder Anfrage ein API-Key angehängt werden. Dieser Key dient zur Authentifizierung einzelner Nutzer und der Zuweisung von Berechtigungen an der API. Dadurch soll außerdem Missbrauch vermieden werden. Die Authentifizierung erfolgt mit dem Parameter “api_key”.

Beispiel in URL-Form:

http://www.apileipzig.de/api/v1/mediahandbook/companies?api_key=2dG3ds32wqr289u7i49e

Beispiel mit cURL:

curl http://www.apileipzig.de/api/v1/mediahandbook/companies -F 'api_key=2dG3ds32wqr289u7i49e'

Spezifikation der Schnittstelle

Allgemeine Form

http://www.apileipzig.de/api/v1/Datenquelle/Ressource[/][ID][?][Parameter]

Erklärung

Die Standard-URL ist

http://www.apileipzig.de/api/v1/

“Datenquelle” spezifiziert welche Datenquelle abgefragt werden soll.
Alle verfügbaren Datenquellen finden Sie unter Datenquellen.

“Ressource” spezifiziert welche Ressource einer Datenquelle abgefragt werden soll.
Alle verfügbaren Ressourcen finden Sie unter Ressourcen.

“Parameter” können an die Abfrage angehängt werden, um diese zu verfeinern. Siehe dazu allgemeine Parameter, die Spezifikation der einzelnen Ressourcen und die Suche.

Beispiel:

http://www.apileipzig.de/api/v1/mediahandbook/companies
Die Rückgabe dieser Anfrage ist eine Liste von Unternehmen im JSON-Format. Siehe dazu auch Paging?

Um einen Datensatz direkt abzufragen, kann eine id angehängt werden

http://www.apileipzig.de/api/v1/mediahandbook/companies/125
Die Rückgabe dieser Anfrage ist das Unternehmen mit der id 125 im JSON-Format.

Weitere Beispiele finden Sie unter Beispielabfragen.
Vergessen Sie nicht, Ihren API-Key anzuhängen um die Abfragen auszuprobieren.

Es können optional allgemeine Parameter festgelegt werden, um die Anfrage genauer zu definieren.
Siehe dazu allgemeine Parameter

Denken Sie daran, jede URL ohne abschließenden Slash (“/”) zu verwenden.

Validierung

Es gibt zwei Stufen in denen der Request validiert wird.
Zu Beginn wird auf formale Korrektheit geprüft. Wenn diese Validierung korrekt ist, wird auf logische Korrektheit mit der Datenbank geprüft. Bitte überprüfen Sie immer die Rückgabe der API um sicherzugehen, dass die Anfrage korrekt verarbeitet wurde.

Rückgabe

Das Encoding jeder Rückgabe ist immer UTF-8.
Weitere Informationen zum Format der Rückgabe finden Sie unter allgemeine Parameter.

Code-Beispiele

Aktuelle Code-Beispiele finden Sie unter Codebeispiele.

Beispielabfragen

Eine Übersicht über die möglichen Abfrageparameter finden Sie unter Beispielabfragen

An der API mitentwickeln

Unterstützen Sie die API.LEIPZIG

Bitte unterstützen Sie andere API.LEIPZIG-Nutzer mit hilfreichen Wiki-Inhalten. Bearbeiten Sie dazu einfach diesen Text mit Klick auf “Bearbeiten” oder hinterlassen Sie uns Ihre Ideen im Feedback-Forum.