Share
Vor nicht allzu langer Zeit schrieb ich einen Artikel über "Die zunehmende Bedeutung von APIs in der Webentwicklung". Im Folgenden werde ich heute die Grundlagen der Verwendung von Web-APIs behandeln.
Bevor wir beginnen: Dieser Artikel beschreibt nicht den Prozess des API-Designs oder der API-Entwicklung. Das ist für einen anderen Artikel!
Bei der Verwendung von Web-APIs sollten einige grundlegende Prinzipien beachtet werden:
Die meisten dieser Richtlinien sind in den API-Nutzungsbedingungen für Twitter und Facebook aufgeführt. Sie können jedoch auf alle Web-APIs angewendet werden.
Es gibt Tausende von Web-APIs, und die meisten können entweder in eine Website integriert werden oder ein Mashup erstellen. Einige Web-APIs sind recht einfach und erfordern nur minimale Programmierkenntnisse, während andere sehr komplex sein können und fortgeschrittene Programmierkenntnisse erfordern.
Die Programmiersprache, mit der Sie ein Web-API in Ihre Website integrieren, hängt sicherlich davon ab, mit welcher Sie sich am wohlsten fühlen. Sie werden feststellen, dass viele Web-APIs wie Flickr und Last.fm sprachspezifische Toolkits anbieten.
Jedes Web-API hat bestimmte Bedingungen bezüglich seiner Verwendung. Daher ist es äußerst wichtig, dass die "Bedingungen" sorgfältig gelesen werden. Sie werden viele Aspekte der Web-API-Nutzung detailliert beschreiben, einschließlich:
Es können zusätzliche "Nutzungsbedingungen" auf separaten Webseiten vorhanden sein. Zum Beispiel gibt es "Display Guidelines", die auf separaten Webseiten für Twitter, Foursquare, LinkedIn und Facebook ausführlich beschrieben werden.
Die meisten Web-APIs verfügen über eine detaillierte Dokumentation, die in der Regel wichtige Informationen enthält, z.
Einige Web-API-Anbieter empfehlen die Verwendung eines Versionierungsparameters im API-Aufruf.
Viele Web-API-Anbieter veröffentlichen häufig neue Versionen ihrer APIs. Diese neuen Versionen können Folgendes enthalten:
Einige Web-API-Anbieter empfehlen die Verwendung eines Versionierungsparameters im API-Aufruf. Foursquare akzeptiert beispielsweise den Parameter "v = YYYYMMDD" in API-Aufrufen. Dieser Parameter zeigt an, dass der Client zum angegebenen Datum auf dem neuesten Stand ist.
Es ist eine gute Idee, das Änderungsprotokoll regelmäßig zu überprüfen (sofern vorhanden), wenn Web-APIs verwendet werden. Viele beliebte APIs verfügen über Änderungsprotokolle wie Facebook, Google Maps, Google Charts und Foursquare.
Viele API-Anbieter bieten zusätzliche Möglichkeiten, um ihre API-Versionen zu verfolgen:
Nahezu alle Web-APIs unterliegen Preisbeschränkungen. Einige API-Anbieter erheben sogar Gebühren, wenn ein Benutzer das API-Ratenlimit überschreitet!
Die Verwendung der meisten APIs (wenn nicht aller APIs) unterliegt Ratenbeschränkungen, und jeder API-Anbieter verfügt über eine eigene API-Ratenbeschränkungsrichtlinie. Einige API-Anbieter erheben sogar Gebühren, wenn ein Benutzer das API-Ratenlimit überschreitet! Google hat kürzlich eine neue Preisbegrenzungsrichtlinie für die Google Maps API eingeführt, die Nutzungsgebühren enthält. Google hat außerdem weitere Details zu den Google API-Nutzungsbeschränkungen in seinem Geo Developers Blog bereitgestellt. Hier finden Sie Links, um Informationen zu Preisbeschränkungen für einige der bekannteren APIs zu erhalten:
Es ist unglaublich wichtig, dass Sie die API nicht missbrauchen. Wenn Ihre Website für jede einzelne Seite einen API-Aufruf tätigt, und für jeden Besucher fragen Sie sich: "Warum"? Implementieren Sie geeignete Caching-Techniken, um die Leistung Ihrer Website zu verbessern und möglicherweise Geld zu sparen.
Die Verwendung einer "Cache-Datei" verhindert Probleme mit der API-Ratenbegrenzung.
Die Verwendung einer "Cache-Datei" verhindert Probleme mit der API-Ratenbegrenzung. Im Nettuts + -Post "So erstellen Sie ein erweitertes Twitter-Widget" finden Sie Anweisungen zum Erstellen eines PHP-Skripts "Cache-Datei". Dieses Skript ruft die Informationen der Twitter-API "GET statuses / user_timeline" ab und speichert sie in einer "TXT" -Datei, die sich in einem Cache-Verzeichnis auf dem Server befindet. Dieses Skript kann leicht geändert werden, um mit den meisten APIs zu arbeiten. Sie müssen lediglich den Namen der TXT-Datei und den API-Aufruf ändern. Beachten Sie, dass der Aufruf im Skript die Daten im JSON-Format abruft.
Es ist wichtig, dass Sie die "Nutzungsbedingungen" der APIs lesen, um sich auf die Verwendung von Cache-Dateien zu beziehen. Beispielsweise hat die Amazon Product Advertising-API Einschränkungen beim Zwischenspeichern. Facebook empfiehlt, bei der Zwischenspeicherung die Daten auf dem neuesten Stand zu halten.
Die zwei beliebtesten Datenformate für Web-APIs sind XML und JSON.
Die zwei beliebtesten Datenformate für Web-APIs sind XML und JSON. Viele Anbieter bieten beide Formate an. JSON ist jedoch unter Web-Entwicklern so beliebt, dass einige API-Anbieter wie Foursquare, Twitter und Google+ ausschließlich das JSON-Datenformat anbieten.
API-Datenformate werden in einem früheren Beitrag ausführlich behandelt.
Bei den meisten API-Anbietern müssen sich Benutzer für ein Benutzerkonto und / oder einen API-Schlüssel anmelden. Beispielsweise fordert Google seine Benutzer auf, hier einen API-Schlüssel anzufordern. Dies ist normalerweise ein ziemlich einfacher Prozess und sollte nur einige Minuten dauern. Sie können auch aufgefordert werden, eine Entwickler- / Anwendungs-ID zu verwenden, wenn Sie eine API verwenden.
Viele APIs erfordern die Verwendung von OAuth für bestimmte API-Funktionen.
OAuth (Open Authorization) ist ein offener Standard für die Autorisierung, mit dem Benutzer Daten und / oder Dateien, die auf einer Website gespeichert sind, mit einer anderen Website gemeinsam nutzen können.
Viele APIs erfordern die Verwendung von OAuth für bestimmte API-Funktionen, z. B. das An- und Abmelden bei einer Anwendung. Für die Google+ API sind ALLE API-Aufrufe erforderlich, um ein OAuth 2.0-Token oder einen API-Schlüssel zu verwenden. Google empfiehlt die Verwendung von OAuth 2.0 als Autorisierungsprotokoll für Google-APIs. Andere Beispiele für APIs, für die OAuth erforderlich ist, sind LinkedIn, Twitter und Foursquare.
Ein API-Aufruf muss verwendet werden, damit Ihre Website-Anwendung auf eine Web-API zugreifen kann. Je nach Art der Anwendung, die Sie erstellen, müssen Sie möglicherweise mehrere API-Aufrufe verwenden. Die meisten APIs können mit einer Vielzahl von Programmiersprachen verwendet werden. Der Aufruf muss möglicherweise für verschiedene Programmiersprachen geändert werden. Im Tutorial "So erstellen Sie ein erweitertes Twitter-Widget" wird beispielsweise ein PHP-Skript "Cache-Datei" mit dem folgenden Twitter-API-Aufruf erstellt:
http://api.twitter.com/1/statuses/user_timeline/twitter_screen_name.json?count=3&include_rts=true&include_entities=true
Wenn Sie JavaScript oder jQuery anstelle von PHP verwenden, muss der Aufruf folgendermaßen geändert werden:
http://api.twitter.com/1/statuses/user_timeline/envatowebdev.json?count=3&include_rts=true&include_entities=true&callback=?
Bei Verwendung von JavaScript oder jQuery, "& callback =?" muss im API-Aufruf enthalten sein, aber wenn Sie PHP verwenden, muss es entfernt werden, oder die Daten werden nicht in einem gültigen JSON-Format generiert.
Es stehen verschiedene API-Testtools zur Verfügung, mit denen Sie Ihre API-Aufrufe testen können:
Bei unerwarteten Problemen mit einer API bieten einige API-Anbieter wie Foursquare und Twitter Aktualisierungen der Plattformstatus in Statusblogs an.
Facebook bietet ein schönes "Live Status Tool", das Folgendes beinhaltet:
Twitter hat auch eine aktuelle "API Status Page", die Folgendes beinhaltet:
Web-APIs werden für die Webentwicklung immer wichtiger, und ihre Beliebtheit und Nutzung hat in den letzten Jahren exponentiell zugenommen. Hoffentlich enthält dieser Artikel detaillierte Informationen zur Verwendung von Web-APIs. Falls es zusätzliche Anmerkungen gibt, die ich nicht aufgenommen habe, erwähnen Sie sie bitte in den Kommentaren.
Accentsconagua