[[readAPI()]]
 

Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

de:create:functions:readapi [21.10.2014 21:46] (aktuell)
admin Ausgelagert aus functions-proc
Zeile 1: Zeile 1:
 +====== 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//​ -- [[https://​developers.google.com/​maps/​documentation/​javascript/​reference|Google Maps v3]]
 +    * //​cloudmade.geocoding.v2//​ -- [[http://​developers.cloudmade.com/​projects/​show/​geocoding-http-api|Cloudmade:​ Geocoding/​Geosearch]]
 +    * **Hinweis:​** Weitere APIs können im Rahmen konkreter Forschungsprojekte ergänzt werden -- richten Sie entsprechende Anfragen bitte direkt an [[info@soscisurvey.de|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.
 +
 +
 +===== Beispiel =====
 +
 +<code php>
 +// 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>'​);​
 +</​code>​
 +
 +<code php>
 +// 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);
 +</​code>​
de/create/functions/readapi.txt · Zuletzt geändert: 21.10.2014 21:46 von admin
 
Falls nicht anders bezeichnet, ist der Inhalt dieses Wikis unter der folgenden Lizenz veröffentlicht: CC Attribution-Share Alike 4.0 International
Driven by DokuWiki