readAPI()

array readAPI(string API-ID, string Request, [string API-Schlüssel])

APIs (standardisierte Schnittstellen, Application Programming Interface) erlauben die Einbindung der Dienste von Drittanbietern in die eigene Software bzw. in den eigenen Fragebogen. Mit der Funktion readAPI() kann man direkt innerhalb des Fragebogens auf solche Dienste zugreifen.

• API-ID
  Die Kennung für den Dienst, der verwendet werden soll. Derzeit unterstützt SoSci Survey folgende APIs:
  • google.maps.v3 – Google Maps v3
  • cloudmade.geocoding.v2 – Cloudmade: Geocoding/Geosearch
  • Hinweis: Weitere APIs können im Rahmen konkreter Forschungsprojekte ergänzt werden – richten Sie entsprechende Anfragen bitte direkt an SoSci Survey
• Request
  Die Anfrage an die API, kodiert im GET-Format
• API-Schlüssel
  Sofern die Nutzung der API die Angabe eines Schlüssels erfordert, wird dieser als dritter Parameter angegeben. Ein Schlüssel dient i.d.R. der Abrechnung von API-Dienstleistungen.

Die Funktion übersetzt die Antwort der API direkt in ein Array, welches unter PHP relativ einfach verwendet werden kann. Nutzen Sie die Funktion debug(), um den Inhalt der Antwort anzuzeigen.

// Anfrage an Googe Maps (Suche einer Straße anhand der Koordinaten)
$v = readAPI('google.maps.v3','latlng=40.714224,-73.961452&sensor=false');
debug($v);
// Ausgabe der gefundenen Straße
html('<p>Straße: '.$v['results'][0]['address_components'][1]['long_name'].'</p>');

// Anfrage an Cloudmade
$v = readAPI('cloudmade.geocoding.v2','around=52.4870,13.4248&distance=closest&object_type=address&return_location=true','API-KEY');
debug($v);