SimpleSearch API: Unterschied zwischen den Versionen

Aus Imperia Support Wiki
(Möglichkeiten)
(Link Beispiel zur automatischen API-Dokumentation einer SimpleSearch-Anwendung)
 
(6 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 5: Zeile 5:
 
Jede SimpleSearch-Anwendung kann folgende technische Formate exportieren:
 
Jede SimpleSearch-Anwendung kann folgende technische Formate exportieren:
  
* XML (siehe [[Simple Search XML]])
+
* XML (siehe [[SimpleSearch XML]])
 
* JSON (siehe [[SimpleSearch JSON]])
 
* JSON (siehe [[SimpleSearch JSON]])
 
* CSV
 
* CSV
Zeile 16: Zeile 16:
 
Folgende Anfragen können Sie stellen:
 
Folgende Anfragen können Sie stellen:
  
* Die letzten Änderungen
 
 
* Gesamter Datenbestand
 
* Gesamter Datenbestand
 
* Datenbestand, der auf eine spezielle Suche zutrifft
 
* Datenbestand, der auf eine spezielle Suche zutrifft
Zeile 23: Zeile 22:
  
 
# Rufen Sie die Anwendung, für die Sie sich interessieren, in Ihrem Browser auf
 
# Rufen Sie die Anwendung, für die Sie sich interessieren, in Ihrem Browser auf
# Stellen Sie ggf. eine Frage über das Suchformular
+
# Stellen Sie eine Frage über das Suchformular
 
# Fügen Sie einen URL-Parameter je nach gewünschtem Datenformat hinzu
 
# Fügen Sie einen URL-Parameter je nach gewünschtem Datenformat hinzu
  
Insgesamt gibt es zwei Fälle bei der Veränderung der URL zu beachten:
+
Folgende Veränderung muss an der URL nach der Suche vorgenommen werden:
  
# Aus http://www.berlin.de/sen/finanzen/haushalt/zuwendungen/ wird http://www.berlin.de/sen/finanzen/haushalt/zuwendungen/index.php/index/index.'''FORMAT'''
+
# Aus http://www.berlin.de/sen/finanzen/service/zuwendungsdatenbank/?q=Test wird http://www.berlin.de/sen/finanzen/service/zuwendungsdatenbank/index.php/index.'''FORMAT'''?q=Test
# Aus http://www.berlin.de/sen/finanzen/haushalt/zuwendungen/index.php?q=Test wird http://www.berlin.de/sen/finanzen/haushalt/zuwendungen/index.php/index/index.'''FORMAT'''?q=Test
 
  
 
Für '''FORMAT''' setzen Sie dann entsprechend 'json', 'xml', 'rss', 'csv', 'jrss' bzw. 'kml' ein.
 
Für '''FORMAT''' setzen Sie dann entsprechend 'json', 'xml', 'rss', 'csv', 'jrss' bzw. 'kml' ein.
Zeile 40: Zeile 38:
  
 
Die möglichen Suchparameter leiten Sie bitte aus dem Suchformular ab.
 
Die möglichen Suchparameter leiten Sie bitte aus dem Suchformular ab.
 +
 +
Einen Überblick über erlaubte Parameter ergibt sich auch aus der automatischen Api-Dokumentation mittels .../index.php/api.html.
 +
# Bsp: http://www.berlin.de/sen/finanzen/service/zuwendungsdatenbank/index.php/api.html
  
 
==== Einschränkung ====
 
==== Einschränkung ====

Aktuelle Version vom 27. Mai 2015, 20:36 Uhr

Jede SimpleSearch-Applikation verfügt über eine einfache REST-API. Damit können Sie den Datenbestand aus einer SimpleSearch-Webanwendung im strukturierten, maschinenlesbaren Format abfragen. Diese REST-APIs werden u.a. auch bei SimpleSearch OpenData veröffentlicht.

Möglichkeiten

Jede SimpleSearch-Anwendung kann folgende technische Formate exportieren:

Folgende Anfragen können Sie stellen:

  • Gesamter Datenbestand
  • Datenbestand, der auf eine spezielle Suche zutrifft

Vorgehen

  1. Rufen Sie die Anwendung, für die Sie sich interessieren, in Ihrem Browser auf
  2. Stellen Sie eine Frage über das Suchformular
  3. Fügen Sie einen URL-Parameter je nach gewünschtem Datenformat hinzu

Folgende Veränderung muss an der URL nach der Suche vorgenommen werden:

  1. Aus http://www.berlin.de/sen/finanzen/service/zuwendungsdatenbank/?q=Test wird http://www.berlin.de/sen/finanzen/service/zuwendungsdatenbank/index.php/index.FORMAT?q=Test

Für FORMAT setzen Sie dann entsprechend 'json', 'xml', 'rss', 'csv', 'jrss' bzw. 'kml' ein.

Quelltextschnipsel mit RSS-URL

Alternativ können Sie sich auch den Quelltext der Seite aufrufen, und den RSS-Eintrag suchen. In diesem Eintrag können Sie dann ".rss" durch ".csv" etc. ersetzen.

Anfragen

Die möglichen Suchparameter leiten Sie bitte aus dem Suchformular ab.

Einen Überblick über erlaubte Parameter ergibt sich auch aus der automatischen Api-Dokumentation mittels .../index.php/api.html.

  1. Bsp: http://www.berlin.de/sen/finanzen/service/zuwendungsdatenbank/index.php/api.html

Einschränkung

Bitte beachten Sie, dass die REST-APIs an der SimpleSearch keine Hochleistungs-APIs sind. Wir bitten also um Caching.