Api

Aus deutschland api

Wechseln zu: Navigation, Suche

Dieser Artikel beschreibt die Nutzung der "deutschland-api". Wir stellen viele spannende Informationen bereit und in diesem Artikel erfahren Sie wie einfach es ist diese zu nutzen.

Inhaltsverzeichnis

REST Interface

Mit der "deutschland-api" stellen wir Ihnen ein effizientes REST-interface zur verfügung. Das hat folgende Vorteile:

  • einfache/unkomplizierte Nutzung
  • hohe kompatibilität
  • hohe performance

Request

Grundsätzlich wird immer die gleiche Basis-URL aufgerufen:

http://v1.d-api.de/


Sie können die URL über GET oder POST aufrufen, da wir über HTTP arbeiten sind der Kompatibilität kaum Grenzen gesetzt, so gut wie jede Programmiersprache ist in der Lage HTTP zu nutzen. Es ist z.b. schon mit einem herkömmlichen Browser möglich Informationen aus der API zu erhalten.

Um eine höchstmögliche kompatibilität zu erreichen beschränken wir uns nicht auf verschiedene Ausgabeformate unserer Daten. Die "deutschland-api" kann über eine Adapterebene genutzt werden, die so genannte "yahoo query language" kurz "yql". Die Nutzung von yql bietet Ihnen eine große Kompatibilität, so ist es z.b möglich ohne große Anpassungen jede Schnittstelle die eine yql Unterstützung anbietet auf die gleiche weise zu benutzen.

Result

Eine einfache Abfrage liefert 10 Resultate, wobei folgende Ausgabeformate unterstützt werden:

  • XML
  • JSON (standard)
  • JSONP
  • CSV
  • Key Value

URI Definition

Der URI für das ausführen von Aktionen ist Hierarchisch aufgebaut:

[ basis-url ] / [ stamm.daten ] / [ methode ]/?[ parameter1=wert1&parameter2=wert2 ]

basis-url

Der Basis-URL ist statisch und daher immer gleich.

http://v1.d-api.de/

stamm.daten

Die Stammdaten geben an auf welche Daten zugegriffen werden soll. Es existieren:

parlament.bund.politiker
parlament.bund.petitionen
parlament.bund.petitionen.menschen
parlament.bund.petitionen.mitzeichner
parlament.bund.wahlkreise
parlament.bund.wahlkreise.geodaten
parlament.bund.wahlkreise.ortsdaten
parlament.bund.ausschuesse

Im moment erweitern wir die Datenstämme um Akteuere und Aktivität der Politik auf Bundesebene abbildbar zu machen.

Methoden

Auf einen Stamm an Daten kann man Methoden ausführen, dabei unterscheiden wir in drei Kategorien:

  • Administrative Methoden (liefert Informationen zur Nutzung der API)
  • Lesende Methoden (um Informationen aus den Stammdaten zu lesen)
  • Schreibende Methoden (um Datenstamm zu verändern/erweitern)

Parameter

Einer Methode können Parameter übergeben werden, dabei gibt folgende Arten von Parametern:

  • Einfache Parameter:
    • Feldname=Wert


  • Erweiterte Parameter:
    • output_type=[type] (bestimmt das Ausgabeformat)
    • limit=[integer] (definiert die Anzahl der Resultate)
    • where.id=[integer] (Selektor für das Ändern von Daten)
    • api_user=[username]&api_key=[apikey] (authorisieren eines User's)

Anwendungsbeispiel

http://v1.d-api.de/parlament.bund.petitionen/get?status=in der Mitzeichnung&limit=2

(Der Aufruf dieser URI liefert 2 Bundestag-petitionen bei denen der "Status" auf "in der Mitzeichnung" steht.)

Resultat im Json Format:

{"data":[
{
  "id":"6321",
  "titel":null,
  "beschreibung":null,
  "text":null,
  "hauptpetent":"65",
  "status":"in der Mitzeichnung",
  "bundestag_board_id":"1344.0",
  "ended":"2009-11-03 01:00:00",
  "started":"2009-07-23 02:00:00",
  "system_updated":"2009-10-29 17:40:43"
},
{
  "id":"6769",
  "titel":"Verbraucherschutz - Umweltampel ",
  "beschreibung":null,
  "text":null,
  "hauptpetent":"60",
  "status":"in der Mitzeichnung",
  "bundestag_board_id":"1352.0",
  "ended":"2009-11-04 01:00:00",
  "started":"2009-08-19 02:00:00",
  "system_updated":"2009-10-29 17:40:41"
}],
"limit":[0,"2"],
"code":200
}

Eine Umfangreiche Liste mit Beispielen finden sie unter Snippets.

API-Console

MediaWiki:Sidebar