Share
Il n'y a pas si longtemps, j'ai écrit un article sur "L'importance croissante des API dans le développement Web". En guise de suivi, je traiterai aujourd’hui des bases de l’utilisation des API Web..
Avant de commencer: cet article ne détaille pas le processus de conception ou de développement d'API. C'est pour un article différent!
Une poignée de principes de base doivent être suivis lors de l'utilisation des API Web:
La plupart de ces instructions sont répertoriées dans les "conditions de service" de l'API pour Twitter et Facebook, mais peuvent être appliquées à toutes les API Web..
Il existe des milliers d'API Web disponibles et la plupart peuvent être intégrées à un site Web ou créer un mashup. Certaines API Web sont relativement simples et implémentent des compétences de programmation minimales, tandis que d'autres peuvent être extrêmement complexes et requièrent des compétences de programmation avancées..
Le langage de programmation que vous utilisez pour intégrer une API Web à votre site Web dépend certainement de ceux avec lesquels vous êtes le plus à l'aise. Vous constaterez que de nombreuses API Web, telles que Flickr et Last.fm, proposent des kits d'outils spécifiques aux langues..
Chaque API Web a des termes spécifiques concernant son utilisation; il est donc extrêmement important que les "termes et conditions" soient lus avec attention. Ils détailleront de nombreux aspects de l'utilisation de l'API Web, notamment:
Des informations supplémentaires sur les "conditions d'utilisation" peuvent figurer sur des pages Web distinctes. Par exemple, il existe des "consignes d'affichage" décrites en détail sur des pages Web distinctes pour Twitter, Foursquare, LinkedIn et Facebook..
La plupart des API Web disposent d'une documentation détaillée, qui contient généralement des informations importantes telles que:
Certains fournisseurs d'API Web recommandent l'utilisation d'un paramètre de gestion des versions dans l'appel d'API..
De nombreux fournisseurs d'API Web publient fréquemment de nouvelles versions de leurs API. Ces nouvelles versions peuvent inclure les éléments suivants:
Certains fournisseurs d'API Web recommandent l'utilisation d'un paramètre de gestion des versions dans l'appel d'API. Foursquare, par exemple, accepte le paramètre "v = AAAAMMJJ" dans les appels d'API. Ce paramètre aidera à indiquer que le client est à jour à la date spécifiée.
Il est judicieux de vérifier régulièrement le journal des modifications (s'il en existe un) lors de l'utilisation des API Web. De nombreuses API populaires disposent de journaux de modifications, tels que Facebook, Google Maps, Google Charts et Foursquare..
De nombreux fournisseurs d'API offrent des moyens supplémentaires de suivre leurs révisions d'API:
Presque toutes les API Web sont soumises à des limites de taux; certains fournisseurs d'API facturent même des frais si un utilisateur dépasse la limite de taux de l'API!
L'utilisation de la plupart des API (sinon de toutes) est soumise à des limites de débit et chaque fournisseur d'API a sa propre stratégie de limitation de débit d'API. Certains fournisseurs d'API facturent même des frais si un utilisateur dépasse la limite de taux de l'API! Google a récemment introduit une nouvelle politique de limitation de taux pour l’API Maps, qui comprend des frais d’utilisation. Google a également fourni des informations supplémentaires sur les limites d'utilisation de l'API Google Maps sur son blog Geo Developers. Voici des liens vers des informations de limitation de taux pour quelques-unes des API les plus populaires:
Il est extrêmement important de ne pas abuser de l'API. Si votre site Web effectue un appel d'API pour chaque chargement de page, et pour chaque visiteur, demandez-vous «Pourquoi»? Mettez en œuvre des techniques de mise en cache appropriées pour améliorer les performances de votre site Web et potentiellement réaliser des économies.
L'utilisation d'un "fichier de cache" évitera les problèmes liés à la limitation de la vitesse de l'API..
L'utilisation d'un "fichier de cache" évitera les problèmes liés à la limitation de la vitesse de l'API. Dans le message "Comment créer un widget Twitter avancé" dans Nettuts +, vous trouverez des instructions sur la création d'un script PHP "fichier de cache". Ce script récupère les informations de l'API Twitter "GET statuses / user_timeline" et les stocke dans un fichier "TXT" situé dans un répertoire de cache sur le serveur. Ce script peut être facilement modifié pour fonctionner avec la plupart des API. Tout ce que vous devez faire est de changer le nom du fichier txt et l'appel de l'API. Notez que l'appel dans le script récupère les données au format JSON.
Il est important que vous lisiez les "conditions d'utilisation" des API pour toute référence à l'utilisation de fichiers cache. Par exemple, l'API Amazon Product Advertising a des restrictions sur la mise en cache. Facebook recommande que, si vous utilisez la mise en cache, vous devriez essayer de garder les données à jour..
Les deux formats de données les plus populaires pour les API Web sont XML et JSON..
Les deux formats de données les plus populaires pour les API Web sont XML et JSON; de nombreux fournisseurs proposent les deux formats. JSON est cependant devenu si populaire parmi les développeurs Web que certains fournisseurs d’API, tels que Foursquare, Twitter et Google+, offrent exclusivement le format de données JSON.
Les formats de données de l'API sont couverts en détail dans un précédent post.
La plupart des fournisseurs d'API imposent aux utilisateurs de créer un compte utilisateur et / ou une clé API. Par exemple, Google demande à ses utilisateurs de demander une clé API ici. Il s’agit généralement d’un processus assez simple qui ne devrait prendre que quelques minutes. Vous pouvez également être invité à utiliser un identifiant développeur / application lors de l'utilisation d'une API.
De nombreuses API nécessitent l'utilisation de OAuth pour des fonctionnalités spécifiques de l'API.
OAuth (Open Authorization) est un standard ouvert d'autorisation permettant aux utilisateurs de partager des données et / ou des fichiers stockés sur un site Web avec un autre site Web..
De nombreuses API requièrent l'utilisation de OAuth pour des fonctionnalités spécifiques de l'API, telles que la connexion et la déconnexion d'une application. L'API Google+ requiert que TOUS les appels d'API utilisent un jeton OAuth 2.0 ou une clé d'API. Google recommande d'utiliser OAuth 2.0 comme protocole d'autorisation pour les API Google. LinkedIn, Twitter et Foursquare sont d’autres exemples d’API nécessitant l’utilisation d’OAuth..
Un "appel" API doit être utilisé pour que votre application de site Web puisse accéder à une API Web. Selon le type d'application que vous créez, vous devrez peut-être utiliser plusieurs appels d'API. La plupart des API peuvent être utilisées avec une variété de langages de programmation. L'appel peut devoir être modifié pour différents langages de programmation. Par exemple, dans le didacticiel, "Comment créer un widget Twitter avancé", un script PHP "fichier de cache" est créé à l'aide de l'appel API Twitter suivant:
http://api.twitter.com/1/statuses/user_timeline/twitter_screen_name.json?count=3&include_rts=true&include_entities=true
Si vous utilisez JavaScript ou jQuery au lieu de PHP, l'appel devra être changé en:
http://api.twitter.com/1/statuses/user_timeline/envatowebdev.json?count=3&include_rts=true&include_entities=true&callback=?
Lorsque vous utilisez JavaScript ou jQuery, "& callback =?" doit être inclus dans l'appel API, mais si PHP est utilisé, il doit être supprimé ou les données ne seront pas générées dans un format JSON valide.
Il existe plusieurs outils de test d'API disponibles pour vous aider à tester vos appels d'API:
Si vous rencontrez des problèmes inattendus avec une API, certains fournisseurs d'API, tels que Foursquare et Twitter, proposent des mises à jour de statut de plate-forme sur les blogs de statut..
Facebook offre un bel "outil d'état en direct" qui comprend:
Gazouillement possède également une "page d'état de l'API" à jour qui comprend:
Les API Web jouent un rôle de plus en plus important dans le développement Web, et leur popularité et leur utilisation ont augmenté de façon exponentielle ces dernières années. J'espère que cet article a détaillé les bases de l'utilisation des API Web. S'il y a des notes supplémentaires que je n'ai pas incluses, merci de les mentionner dans les commentaires..
Accentsconagua