Share
Nu cu mult timp în urmă, am scris un articol despre "Importanța crescândă a API-urilor în dezvoltarea web-ului". Ca o continuare, astăzi, voi acoperi elementele de bază ale utilizării API-urilor Web.
Înainte de a începe: acest articol nu detaliază procesul de proiectare sau dezvoltare API. Asta pentru un articol diferit!
Există o serie de principii de bază care trebuie respectate atunci când se utilizează API-uri Web:
Cele mai multe dintre aceste linii directoare sunt enumerate în Termenii și condițiile API pentru Twitter și Facebook, dar pot fi aplicați tuturor API-urilor Web.
Există mii de API-uri web disponibile și cele mai multe pot fi fie integrate într-un site web, fie pentru a crea un mashup. Unele API-uri Web sunt destul de simple și necesită abilități minime de codare pentru implementare, în timp ce altele pot fi extrem de complexe și necesită abilități avansate de programare.
Limba de programare pe care o utilizați pentru a integra un API Web pe site-ul dvs., cu siguranță, depinde de cele cu care vă simțiți mai bine. Veți găsi că multe dintre API-urile Web, cum ar fi Flickr și Last.fm, oferă instrumente de limbă specifice.
Fiecare API Web are termeni specifici cu privire la utilizarea acestuia; așa că este incredibil de important ca "termenii și condițiile" să fie citiți cu atenție. Acestea vor detalia multe aspecte ale utilizării API-ului Web, inclusiv:
Pot exista informații suplimentare privind "condițiile de utilizare" care se găsesc pe pagini web separate. De exemplu, există "Instrucțiuni de afișare" descrise în detaliu pe pagini web separate pentru Twitter, Foursquare, LinkedIn și Facebook.
Majoritatea API-urilor web au o documentație detaliată, care de obicei conține informații importante precum:
Unii Furnizori API Web recomandă utilizarea unui parametru de versiune în apelul API.
Mulți furnizori API Web eliberează frecvent noi versiuni ale API-urilor. Aceste lansări noi pot include următoarele:
Unii Furnizori API Web recomandă utilizarea unui parametru de versiune în apelul API. Foursquare, de exemplu, acceptă paramul "v = YYYYMMDD" în apelurile API. Acest parametru va indica faptul că clientul este actualizat la data specificată.
Este o idee inteligentă să verificați periodic jurnalul de schimbare (dacă există) atunci când utilizați API-uri Web. Multe API-uri populare dispun de jurnale de schimbare, cum ar fi Facebook, Google Maps, Google Charts și Foursquare.
O mulțime de furnizori API oferă modalități suplimentare de a urmări revizuirile API-urilor:
Aproape toate API-urile web sunt supuse limitelor de rată; unii furnizori de API plătesc taxe chiar dacă un utilizator depășește limita ratei API!
Utilizarea celor mai multe (dacă nu toate) API-uri este supusă unor limite de rată și fiecare furnizor API are propriile politici de limitare a ratei API. Unii furnizori de API plătesc taxe chiar dacă un utilizator depășește limita ratei API! Google a introdus recent o nouă politică de limitare a ratei pentru API-ul Maps, care include taxe de utilizare. De asemenea, Google a furnizat detalii suplimentare privind limitele de utilizare a API-urilor Maps pe blogul lor Geo Developers. Iată câteva linkuri pentru a evalua informațiile limitate pentru câteva dintre cele mai populare API-uri:
Este incredibil de important să nu abuzați de API. Dacă sunteți site-ul efectuează un apel API pentru fiecare încărcare a unei singure pagini și pentru fiecare vizitator, întrebați-vă "De ce"? Implementați tehnici de caching adecvate pentru a îmbunătăți performanța site-ului dvs. și, eventual, pentru a economisi bani.
Folosirea unui "fișier cache" va preveni problemele legate de limitarea ratei API.
Folosirea unui "fișier cache" va preveni problemele legate de limitarea ratei API. În postul Nettuts + "Cum se creează un Twitter widget avansat", există instrucțiuni despre crearea unui script PHP "cache file". Acest script extrage informațiile API-ului Twitter "GET statuses / user_timeline" și îl stochează într-un fișier "TXT" situat într-un director cache de pe server. Acest script poate fi ușor modificat pentru a lucra cu majoritatea API-urilor. Tot ce trebuie să faceți este să modificați numele fișierului txt și apelul API. Rețineți că apelul din script readuce datele în format JSON.
Este important să citiți termenii de utilizare ai API pentru orice referință la utilizarea fișierelor cache. De exemplu, API-ul de publicitate Amazon Product conține restricții privind cache-ul. Facebook recomandă ca, dacă utilizați cache-ul, ar trebui să încercați să păstrați datele actualizate.
Cele două formate de date cele mai populare pentru API-urile Web sunt XML și JSON.
Cele două formate de date cele mai populare pentru API-urile Web sunt XML și JSON; mulți furnizori oferă ambele formate. Cu toate acestea, JSON a devenit atât de popular printre dezvoltatorii web până la punctul în care anumiți furnizori de servicii API, cum ar fi Foursquare, Twitter și Google+, oferă formatul de date JSON exclusiv.
Formatele de date API sunt detaliate într-o postare anterioară.
Majoritatea furnizorilor de API solicită utilizatorilor să se înscrie pentru un cont de utilizator și / sau o cheie API. De exemplu, Google solicită utilizatorilor să solicite aici o cheie API. Acesta este de obicei un proces destul de simplu și ar trebui să dureze doar câteva minute de făcut. De asemenea, vi se poate solicita să utilizați un ID de dezvoltator / aplicație atunci când utilizați un API.
Multe API-uri necesită utilizarea OAuth pentru funcționalitate API specifică.
OAuth (autorizație deschisă) este un standard deschis pentru autorizare, care permite utilizatorilor să partajeze date și / sau fișiere stocate pe un site web cu un alt site web.
Multe interfețe API necesită utilizarea funcției OAuth pentru funcționalitatea API specifică, cum ar fi autentificarea și dezactivarea unei aplicații. API-ul Google+ necesită toate apelurile API pentru a utiliza o cheie OAuth 2.0 sau o cheie API. Google recomandă utilizarea OAuth 2.0 ca protocol de autorizare pentru API-urile Google. Alte exemple de API care necesită utilizarea OAuth sunt LinkedIn, Twitter și Foursquare.
Un apel "API" trebuie folosit pentru ca aplicația site-ului dvs. Web să poată accesa un API Web. În funcție de tipul de aplicație pe care o creați, este posibil să fie necesar să utilizați mai multe apeluri API. Majoritatea API-urilor pot fi utilizate cu o varietate de limbi de programare. Este posibil ca apelul să fie modificat pentru diferite limbi de programare. De exemplu, în tutorialul "Cum se creează un widget twitter avansat", se creează un script PHP "cache file" care folosește următorul apel Twitter API:
http://api.twitter.com/1/statuses/user_timeline/twitter_screen_name.json?count=3&include_rts=true&include_entities=true
Dacă utilizați JavaScript sau jQuery în loc de PHP, apelul va trebui să fie schimbat la:
http://api.twitter.com/1/statuses/user_timeline/envatowebdev.json?count=3&include_rts=true&include_entities=true&callback=?
Atunci când utilizați JavaScript sau jQuery, "& Apel invers =?" trebuie să fie inclus în apelul API, dar dacă folosiți PHP, trebuie să fie eliminat sau datele nu vor fi generate într-un format JSON valid.
Există mai multe instrumente de testare API disponibile pentru a vă ajuta să testați apelurile API:
Dacă aveți probleme neașteptate cu un API, unii furnizori API precum Foursquare și Twitter oferă actualizări ale statusului platformei pe blogurile de stare.
Facebook oferă un frumos "Live Status Tool" care include:
Stare de nervozitate are, de asemenea, o actualizare a paginii de stare API care include:
API-urile web devin din ce în ce mai importante în dezvoltarea web-ului, iar popularitatea și utilizarea acestora au crescut exponențial în ultimii ani. Sperăm că acest articol a detaliat elementele de bază ale utilizării API-urilor Web. Dacă există note suplimentare pe care nu le-am inclus, vă rugăm să le menționați în comentarii.
Accentsconagua